🚀 Boilerplate-Next-Js uses Next.js, MUI v5 and TypeScript, Storybook, Zeplin, ESLint, Prettier, Husky, Lint-Staged, Jest, Testing Library, Commitlint, VSCode, Varcel, PostCSS.
Developer experience first:
- ⚡ Next.js for Static Site Generator
- 🔥 Type checking TypeScript
- 💎 Integrate with MUI v5
- ✅ Strict Mode for TypeScript and React 18.2
- 📏 Linter with ESLint (default NextJS, NextJS Core Web Vitals, MUI v5 and Airbnb configuration)
- 💖 Code Formatter with Prettier
- 🦊 Husky for Git Hooks
- 🚫 Lint-staged for running linters on Git staged files
- 🚓 Lint git commit with Commitlint
- 📓 Write standard compliant commit messages with Commitizen
- 🦺 Unit Testing with Jest and React Testing Library
- 👷 Run tests on pull request with GitLab Actions
- 🎁 Automatic changelog generation with Semantic Release
- 💡 Absolute Imports using
@prefix - 🗂 VSCode configuration: Debug, Settings, Tasks and extension for PostCSS, ESLint, Prettier, TypeScript, Jest
- 🤖 SEO metadata, JSON-LD and Open Graph tags with Next SEO
- 🗺️ Sitemap.xml and robots.txt with next-sitemap
- ⚙️ Bundler Analyzer
- 🖱️ One click deployment with Vercel.(or manual deployment to any hosting services)
- 💯 Maximize lighthouse score
Built-in feature from Next.js:
- ☕ Minify HTML & CSS
- 💨 Live reload
- ✅ Cache busting
- All the Next.js pages are statically generated by default. You can easily switch to SSR adding
getServerSidePropsto your page. - Nothing is hidden from you, so you have the freedom to make the necessary adjustments to fit your needs and preferences.
- Minimal code
- SEO-friendly
- 🚀 Production-ready
- Node.js 18+ and npm or yarn
Run the following command on your local environment:
git clone git@xxxxxxxxxxxxxxxxxxxxxxxxxxx
cd Boilerplate-Next-Js
yarn installThen, you can run locally in development mode with live reload:
yarn run devOpen http://localhost:3000 with your favorite browser to see your project.
.
├── README.md # README file
├── __mocks__ # Mocks for testing
├── .GitLab # GitLab folder
├── .husky # Husky configuration
├── .vscode # VSCode configuration
├── public # Public assets folder
├── src
│ ├── components # shared components
│ ├── constants # globel constant
│ ├── types # globel types
│ ├── hooks # hooks
│ ├── modlues # complete feature with all its compenets except shared components
│ ├── pages # Next JS Pages
│ ├── pages.test # Next JS Pages tests (this avoid test to treated as a Next.js pages)
│ ├── styles # Styles folder
│ └── utils # Utility functions
├── .eslintignore # ignore eslint file
├── .eslintrc # eslint config file
├── .gitignore # git ignore file
├── .commitlint.config.js # commitlint config file
├── .jest.config.js # jest config file
├── .jest.setup.js # jest setup file
├── .lint-staged.config.js # lint staged config file
├── .next-sitemap.config.js # next-sitemap config file
├── .next.config.js # next config file
└── tsconfig.json # TypeScript configurationZeplin is a web-based design and collaboration tool that helps software engineers and designers create and manage user interfaces, web designs, and mobile app designs. The tool allows users to easily share design assets, such as colors, fonts, icons, and images, with developers. It also helps developers quickly create the code for the design, and provides a comprehensive library of design elements that can be reused and customized. With Zeplin, developers and designers can collaborate in real-time to create high-quality user interfaces that are consistent, efficient, and optimized for the best user experience.
Storybook is a frontend workshop for building UI components and pages in isolation.
yarn run storybookyarn chromatic --project-token=$CHROMATIC_PROJECT_TOKENThe project enforces Conventional Commits specification. This means that all your commit messages must be formatted according to the specification. To help you write commit messages, the project uses Commitizen, an interactive CLI that guides you through the commit process. To use it, run the following command:
yarn run commitOne of the benefits of using Conventional Commits is that it allows us to automatically generate a CHANGELOG file. It also allows us to automatically determine the next version number based on the types of commits that are included in a release.
You can see the results locally in production mode with:
$ yarn run build
$ yarn run startThe generated HTML and CSS files are minified (built-in feature from Next js). It will also removed unused CSS from MUI v5.
You can create an optimized production build with:
yarn run build-prodNow, your blog is ready to be deployed. All generated files are located at out folder, which you can deploy with any hosting service.
All tests are colocated with the source code inside the same directory. So, it makes it easier to find them. Unfortunately, it is not possible with the pages folder which is used by Next.js for routing. So, what is why we have a pages.test folder to write tests from files located in pages folder.
yarn run testDeploy this Project on Vercel in one click:
If you are VSCode users, you can have a better integration with VSCode by installing the suggested extension in .vscode/extension.json. The starter code comes up with Settings for a seamless integration with VSCode. The Debug configuration is also provided for frontend and backend debugging experience.
With the plugins installed on your VSCode, ESLint and Prettier can automatically fix the code and show you the errors. Same goes for testing, you can install VSCode Jest extension to automatically run your tests and it also show the code coverage in context.
Pro tips: if you need a project wide type checking with TypeScript, you can run a build with Cmd + Shift + B on Mac.
Licensed under the Private License, Copyright © 2023
See LICENSE for more information.
Made with ♥ by Arshan Aslam.