NextJS Boilerplate

This is a more barebones version of ixartz's NextJS Boilerplate to fit my perosnal needs.

Features

⚡ 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
👷 Run tests on pull request with GitHub Actions
🎁 Automatic changelog generation with Semantic Release
💡 Absolute Imports using @ prefix
🗂 VSCode configuration: Debug, Settings, Tasks and extension for PostCSS, ESLint, Prettier, TypeScript
🤖 SEO metadata, JSON-LD and Open Graph tags with Next SEO
🗺️ Sitemap.xml and robots.txt with next-sitemap
⚙️ Bundler Analyzer

Built-in feature from Next.js:

☕ Minify HTML & CSS
💨 Live reload
✅ Cache busting

Philosophy

All the Next.js pages are statically generated by default. You can easily switch to SSR adding getServerSideProps to 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

Requirements

Node.js 14+ and pnpm

Getting started

Run the following command on your local environment:

git clone --depth=1 https://github.com/ixartz/Next-js-Boilerplate.git my-project-name
cd my-project-name
pnpm install

Then, you can run locally in development mode with live reload:

pnpm run dev

Open http://localhost:3000 with your favorite browser to see your project.

.
├── README.md                       # README file
├── .github                         # GitHub folder
├── .husky                          # Husky configuration
├── .vscode                         # VSCode configuration
├── public                          # Public assets folder
├── src
│   ├── layouts                     # Layouts components
│   ├── pages                       # Next JS Pages
│   ├── styles                      # Styles folder
│   └── utils                       # Utility functions
├── tailwind.config.js              # Tailwind CSS configuration
└── tsconfig.json                   # TypeScript configuration

Customization

You 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.png and public/favicon-32x32.png: your website favicon, you can generate from https://favicon.io/favicon-converter/
src/styles/global.css: your CSS file using Tailwind CSS
src/utils/AppConfig.ts: configuration file
src/templates/Main.tsx: default theme
next-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 sky is the limit 🚀.

Commit Message Format

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:

pnpm run commit

One 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.

Deploy to production

You can see the results locally in production mode with:

$ pnpm run build
$ pnpm run start

The generated HTML and CSS files are minified (built-in feature from Next js). It will also removed unused CSS from Tailwind CSS.

You can create an optimized production build with:

pnpm run build-prod

License

See LICENSE for more information.

adiologydev/nextjs-boilerplate