Lukazovic / nextjs-with-chakra-ui-boilerplate

This is a Next.js boilerplate

What is inside?

This project uses lot of stuff as:

• NextJS
• TypeScript
• Chakra-ui
• PWA
• Jest
• React Testing Library
• Storybook
• Eslint
• Prettier
• Husky

Getting Started

To create a project from this boilerplate run:

yarn create next-app MY_PROJECT_NAME --example https://github.com/Lukazovic/nextjs-with-chakra-ui-boilerplate

Then, run the development server:

yarn 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
• typecheck: check typescript types
• generate: creates a component scaffold
• storybook: runs storybook on localhost:6006
• build-storybook: create the build version of storybook

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!

🤔 How to Contribute

• Fork this repository;
• Create your branch with your feature: git checkout -b my-feature;
• Commit your feature: git commit -m 'feat: My new feature';
• Push to your branch: git push origin my-feature.

Then merge your pull request, you can now delete your branch

📝 Author

Lucas Vieira