NextJS Boilerplate

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:

🧐 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...
• Analyze production error messages

📂 Folder Structure

.
├── public
│   └── images
├── scripts
└── src
    ├── __generated__ (GraphQL types auto generate)
    ├── __test__
    │   └── setup
    ├── adapters
    ├── components
    │   ├── common
    │   └── features
    ├── mocks
    ├── pages
    │   ├── api
    │   │   └── ping
    │   └── permission
    │       └── route
    ├── services
    │   └── apollo
    │       ├── resolvers
    │       └── type-defs
    ├── stores
    │   ├── admin
    │   ├── global
    │   └── user
    ├── 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

🤖 Using Docker and Makefile

Development environment - for doing testing

make build-development
make start-development

Open http://localhost:3001

Staging environment - for doing UAT testing

make build-staging
make start-staging

Open http://localhost:3002

Production environment - for users

make build-production
make start-production

Open http://your-domain:80

🍰 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
• Sentry

🛡️ License:

This project is licensed under the MIT

💖Like my work?

Donate me for crypto (USDT)

BEP20 Wallet: 0xbb861e0bd84af04cf370bcf8227537344500bd0a