qinsong77 / next-js-boilerplate

Next.js 14 base boilerplate. Next.js 14+ TypeScript + ESLint + Prettier + Husky + Lint-Staged + Commitlint+ Vitest + React Testing Library + Tailwind CSS + Pino

Next.js 14 Boilerplate

This is a Next.js 14 Boilerplate project base on create-next-app.

Features

• pnpm
• chore
  • husky
  • lint-stage
  • prettier
    • use prettier-plugin-sort-imports ? current is eslint-plugin-simple-import-sort
  • commitlint
• css: tailwindcss
• UI Library: shadcn/ui
• bundle-analyzer: @next/bundle-analyzer
• logger: pino && development pretty logging pino-pretty
• test:
  • vitest
  • react testing library
• i18n(TBD)
  • setting-tutorials
  • next-intl not compatible with turbo mode Module not found: Can't resolve 'next-intl/config'
  • next-international seems better, but not compatible with Not found page
  • Maybe the best choice is official Example: app-dir-i18n-routing
• Docker
• Playwright: Write end-to-end tests like a pro or cypress
• Github actions/CI

TODO

• i18n
• E2E test
• Zustand
• after gpr, run pnpm install automatically
• how to update rsc in client?
• Update to Next.js 15

Know issues

• eslint-plugin-vitest can't updated, otherwise eslint will be broken.

Refers:

• Next.js App Router Playground
• nodejs.org doc web repo
• Next.js Full Stack App Architecture Guide

Getting Started

First, run the development server:

# or
pnpm dev
# or
pnpm dev:turbo

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

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

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.