Next.js boilerplate

What is inside?

This project uses lot of stuff as:

• TypeScript
• NextJS
• Styled Components
• Jest
• React Testing Library
• Cypress
• Eslint
• Prettier
• Husky

Getting Started

First, to create a project using this boilerplate, use this command:

npx create-next-app -e https://github.com/iamdevmarcos/my-boilerplate --use-npm

Optional: If you use yarn to install the dependencies, after install enter in folder of project and remove yarn.lock in the project and install all dependencies using this command:

npm install

Run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

Commands

• dev: runs your application on localhost:3000
• build: creates the production build version
• start: starts a simple server with the build production code
• lint: runs the linter in all components and pages
• test: runs jest to test all components and pages
• test:watch: runs jest in watch mode
• cy:open: runs cypress to e2e tests
• cy:run: runs cypress in headless mode
• prepare: starts husky install and configuration

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.