/nextjs-boilerplate

A super powerful NextJS boilerplate developed following the Feature driven pattern

Primary LanguageTypeScriptMIT LicenseMIT

NextJS Boilerplate

project-image

A super powerful NextJS boilerplate developed following the Feature driven pattern.

🔥 Core Values

  • Always write clean code
  • Think before coding
  • Code has heart
  • Ready to teach each other
  • Responsibility for work
  • Actively discuss

🚀 Demo

https://nextjs-core-project.vercel.app/

Project Screenshots:

project-screenshot

🧐 Features

Here're some of the project's best features:

  • Clean folder structure
  • High scalability
  • Feature driven architecture
  • Multilingualism does not change routes
  • Validate ENV before build
  • Validate branch and commit before commit code
  • Support Storybook
  • Support Unit Test
  • Bla bla bla feature...

📂 Folder Structure

.
├── public (contain static files)
├── scripts (contain script/bash)
├── src
│   ├── __test__
│   │   └── setup
│   │       └── matchMedia.ts
│   ├── app
│   │   ├── api
│   │   │   └── ping
│   │   │       └── route.ts
│   ├── components
│   │   ├── common
│   │   └── features
│   │       ├── feature-1
│   │       │   ├── feature-1.component.tsx
│   │       │   ├── feature-1.constant.ts
│   │       │   ├── feature-1.hook.tsx
│   │       │   ├── feature-1.store.ts
│   │       │   ├── feature-1.test.tsx
│   │       │   └── index.tsx
│   ├── pages (contain page routes)
│   ├── services (contain third services: AWS, Google Cloud)
│   ├── styles (contain module styles)
│   └── utils
│       ├── constants
│       └── helpers

💉 Commit Rules

Must create branch follow below rules:

  • build
  • chore
  • ci
  • docs
  • feat
  • fix
  • perf
  • refactor
  • revert
  • style
  • test

Example: feat: first commit

🤟 Branch Rules

Must create branch follow below rules:

  • feat/
  • feedback/
  • hotfix/
  • revert/
  • reset/
  • force/
  • refactor/
  • fix/

Example: git checkout -b feat/feature-a

Note: Underscore to be not allow!!!

🛠️ Installation Steps:

1. Clone the project

git clone https://github.com/truongdn-it/nextjs-boilerplate

2. Go to the project directory

cd nextjs-boilerplate

3. Install dependencies

npm install

4. Start the server

npm run dev

🍰 Contribution Guidelines:

CONTRIBUTING

💻 Built with

Technologies used in the project:

  • NextJS
  • Antd Design
  • React Query
  • Zustand
  • Commit lint
  • Eslint
  • Prettier
  • Storybook
  • Vitest
  • Apollo Server
  • Apollo Client

🛡️ License:

This project is licensed under the MIT

💖Like my work?

Donate me for crypto (USDT)

BEP20 Wallet: 0xbb861e0bd84af04cf370bcf8227537344500bd0a