NextJS Boilerplate

It's a nextjs boilerplate to quickly start a nextjs project. This boilerplate use default Tailwind CSS plus SASS to style.

Installation

1. Clone the project

git clone [email protected]:matheusdoedev/nextjs-boilerplate.git

Running project in development mode

1. Install dependencies

npm install

yarn

2. Run project

npm run dev

yarn dev

Running project in production mode

1. Install dependencies

npm install

yarn

2. Build project

npm run build

yarn build

3. Run project

npm start

yarn start

Running project in production mode with Docker & Docker Compose

1. Set production env variables

.env.production

NODE_ENV='production'

2. Run with docker-compose

docker-compose up

# or in detach mode

docker-compose up -d

Technologies used in this boilerplate

• React
• Next.js
• TypeScript
• Axios
• Formik
• TailwindCSS
• Yup
• Testing Library
• Jest
• Prettier
• SASS

Contributing

1. Fork it (<git@github.com:matheusdoedev/pizza-army.git>)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes following conventional commits pattern (git commit -am 'feat: add some feature')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request