nextjs-typescript-boilerplate is a pre-configured starter kit for internal developers at Bereyziat Development organization who want to build Next.js applications with TypeScript. It provides a clean project structure with all the necessary dependencies and configurations, so you can start developing your app right away without worrying about the initial setup.
The boilerplate includes pages, components, styles, and assets that follow best practices and internal guidelines. It also comes with helpful scripts and tools for developing, testing, and deploying your app, so you can focus on building high-quality features and delivering value to users.
Whether you're new to Next.js or an experienced developer, nextjs-typescript-boilerplate can help you get started quickly and efficiently, and provide a solid foundation for your next project.
🎯 Developer experience first:
- ⚡ Next.js for Static Site Generator
- 🔥 Type checking TypeScript
- 💎 Integrate with Tailwind CSS
- ✅ Strict Mode for TypeScript and React 18
- 📏 Linter with ESLint (default NextJS, NextJS Core Web Vitals, Tailwind CSS 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
- 🧪 E2E Testing with Cypress
- 👷 Run tests on pull request with GitHub Actions
- 🎉 Storybook for UI development
- 🎁 Automatic changelog generation with Semantic Release
- 🔍 Visual testing with Percy (Optional)
- 💡 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 Netlify (or manual deployment to any hosting services)
- 🌈 Include a FREE minimalist theme
- 💯 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, you have all the freedom to make the necessary adjustments to fit your needs and preferences.
- Minimal code
- SEO-friendly
- 🚀 Production-ready
- Node.js 16+ and npm
Run the following command on your local environment:
git clone --depth=1 https://github.com/Bereyziat-Development/nextjs-typescript-boilerplate.git my-project-name
cd my-project-name
npm installThen, you can run locally in development mode with live reload:
npm run devOpen http://localhost:3000 with your favorite browser to see your project.
├── README.md # README file
├── public # Public assets folder
├── src
│ ├── components # Reusable components: Layouts, Templates, Shared components, Screens.
│ ├── context # Global context providers
│ ├── pages # Next.js pages
│ ├── shared # Utility functions and constants
│ ├── assets # Global styles and images used in the project
│ └── models # Type definitions and interfaces
├── __mocks__ # Mocks function for testing purposes
├── .github # GitHub folder for Continuous Integration and Continuous Deployment
├── .husky # Husky configuration
├── .vscode # VSCode configuration
├── next.config.js # Next.js configuration
├── package.json # Node.js package manager file
├── tailwind.config.js # Tailwind CSS configuration
└── tsconfig.json # TypeScript configurationYou can easily configure Next js Boilerplate by making a search in the whole project with FIXME: for making quick customization. Here is some of the most important files to customize:
public/apple-touch-icon.png,public/favicon.ico,public/favicon-16x16.pngandpublic/favicon-32x32.png: your next website favicon, you can generate from https://favicon.io/favicon-converter/src/styles/global.css: your CSS file using Tailwind CSSsrc/utils/app-config.ts: configuration filesrc/templates/main.template.tsx: default themenext-sitemap.config.js: sitemap configuration
You have access to the whole code source if you need further customization. The provided code is only example for you to start your project. The universe is the limit my friend 🚀.
The 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:
npm 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:
$ npm run build
$ npm run startThe generated HTML and CSS files are minified (built-in feature from Next js). It will also remove unused CSS from Tailwind CSS.
You can create an optimized production build with:
npm run build-prodNow, your project 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.
Deploy this Next JS Boilerplate 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.
Everyone is welcome to contribute to this project. Feel free to open an issue if you have question or found a bug. Totally open to any suggestions and improvements.
Licensed under the MIT License, Copyright © 2022
See LICENSE for more information.