Next-js-Boilerplate

Boilerplate and Starter for Next.js 13+ with App Router and Page Router sup...

Next.jsBoilerplate
ixartz/Next-js-Boilerplate

README

Boilerplate and Starter for Next JS 13+, Tailwind CSS 3.3 and TypeScript


Next js starter banner


🚀 Boilerplate and Starter for Next.js with App Router and Page Router support, Tailwind CSS and TypeScript ⚡️ Made with developer experience first: Next.js, TypeScript, ESLint, Prettier, Husky, Lint-Staged, Jest, Testing Library, Commitlint, VSCode, Netlify, PostCSS, Tailwind CSS, Authentication with Clerk, Database with DrizzleORM (SQLite, PostgreSQL, and MySQL) and Turso

Clone this project and use it to create your own Next.js project. You can check a Next js templates demo.

Sponsors


Clerk – Authentication & User Management for Next.js SQLite Developer Experience Upstash
React SaaS Boilerplate Next.js
        Add your logo here

Features


Developer experience first:

- ⚡ Next.js with App Router and Page Router support
- 🔥 Type checking TypeScript
- 💎 Integrate with Tailwind CSS
- ✅ Strict Mode for TypeScript and React 18
- 🔒 Authentication with Clerk: Sign up, Sign in, Sign out, Forgot password, Reset password, and more.
- 📦 Type-safe ORM with DrizzleORM, compatible with SQLite, PostgreSQL, and MySQL
- 💽 Global Database with Turso
- ♻️ Type-safe environment variables with T3 Env
- ⌨️ Form with React Hook From
- 🔴 Validation library with Zod
- 📏 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
- 🧪 Integration and E2E Testing with Playwright
- 👷 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
- ⌘ Database exploration with Drizzle Studio and CLI migration tool with Drizzle Kit
- ⚙️ Bundler Analyzer
- 🖱️ One click deployment with 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

Philosophy


- Nothing is hidden from you, so you have the freedom to make the necessary adjustments to fit your needs and preferences.
- Easy to customize
- Minimal code
- SEO-friendly
- 🚀 Production-ready

Requirements


- Node.js 16+ and npm

Getting started


Run the following command on your local environment:

  1. ```shell
  2. git clone --depth=1 https://github.com/ixartz/Next-js-Boilerplate.git my-project-name
  3. cd my-project-name
  4. npm install
  5. ```

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

  1. ```shell
  2. npm run dev
  3. ```

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

Set up authentication


Create a Clerk account at Clerk.com and create a new application in Clerk Dashboard. Then, copyNEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY into .env.local file (not tracked by Git):

  1. ```shell
  2. NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_pub_key
  3. CLERK_SECRET_KEY=your_clerk_secret_key
  4. ```

Now, you can a fully working authentication system with Next.js: Sign up, Sign in, Sign out, Forgot password, Reset password, Update profile, Update password, Update email, Delete account, and more.

Set up remote database


The project uses DrizzleORM, a type-safe ORM compatible with SQLite, PostgreSQL, and MySQL databases. By default, the project is set up to work seamlessly with libSQL, and for production purposes, it's integrated with Turso. The Next.js Boilerplate also enables a smooth transition to an alternative database provider if your project requires it.

First, you need to create a Turso account at Turso.tech and install the Turso CLI:

  1. ```shell
  2. brew install tursodatabase/tap/turso
  3. turso auth signup # Sign up to Turso
  4. ```

Then, create a new database:

  1. ```shell
  2. turso db create nextjs-boilerplate
  3. ```

Now, you need to update the DATABASE_URL in .env file with the database URL provided by Turso:

  1. ```shell
  2. turso db show nextjs-boilerplate --url

  4. # .env
  5. # DATABASE_URL=libsql://[RANDOM-CHARS]-[DB-NAME]-[ORG-NAME].turso.io
  6. ```

Finally, you also need to create a new environement variable DATABASE_AUTH_TOKEN in .env.local (not tracked by Git) with the auth token provided by Turso:

  1. ```shell
  2. turso db tokens create nextjs-boilerplate

  4. # .env.local
  5. # DATABASE_AUTH_TOKEN=[your-auth-token]
  6. ```

Project structure


  1. ```shell
  2. .
  3. ├── README.md                       # README file
  4. ├── __mocks__                       # Mocks for testing
  5. ├── .github                         # GitHub folder
  6. ├── .husky                          # Husky configuration
  7. ├── .storybook                      # Storybook folder
  8. ├── .vscode                         # VSCode configuration
  9. ├── migrations                      # Database migrations
  10. ├── public                          # Public assets folder
  11. ├── scripts                         # Scripts folder
  12. ├── src
  13. │   ├── app                         # Next JS App (App Router)
  14. │   ├── components                  # React components
  15. │   ├── layouts                     # Layouts components
  16. │   ├── libs                        # 3rd party libraries
  17. │   ├── models                      # Database models
  18. │   ├── pages                       # Next JS Pages (page router)
  19. │   ├── pages.test                  # Next JS Pages tests (this avoids tests to be treated as a Next.js pages)
  20. │   ├── styles                      # Styles folder
  21. │   ├── templates                   # Templates folder
  22. │   ├── utils                       # Utilities folder
  23. │   └── validations                 # Validation schemas
  24. ├── tests
  25. │   ├── e2e                         # E2E tests
  26. │   └── integration                 # Integration tests
  27. ├── tailwind.config.js              # Tailwind CSS configuration
  28. └── tsconfig.json                   # TypeScript configuration
  29. ```

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
- .env: default environment variables

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:

  1. ```shell
  2. npm run commit
  3. ```

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.

Testing


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.

Integration & E2E Testing


The project uses Playwright for Integration and E2E testing. You can run the tests with:

  1. ```shell
  2. npx playwright install # Only for the first time in a new environment
  3. npm run test:e2e
  4. ```

Enable Edge runtime (optional)


The App Router folder is compatible with the Edge runtime. You can enable it by uncommenting the following lines src/app/layouts.tsx:

  1. ```tsx
  2. // export const runtime = 'edge';
  3. ```

For your information, the database migration is not compatible with the Edge runtime. So, you need to disable the automatic migration in src/libs/DB.ts:

  1. ```tsx
  2. if (process.env.NODE_ENV !== 'production') {
  3.   await migrate(db, { migrationsFolder: './migrations' });
  4. }
  5. ```

After disabling it, you are required to run the migration manually with:

  1. ```shell
  2. npm run db:migrate
  3. ```

You also require to run the command each time you want to update the database schema.

Deploy to production


During the build process, the database migration is automatically executed. So, you don't need to run the migration manually. But, in your environment variable, DATABASE_URL and DATABASE_AUTH_TOKEN need to be defined.

Then, you can generate a production build with:

  1. ```shell
  2. $ npm run build
  3. ```

It generates an optimized production build of the boilerplate. For testing the generated build, you can run:

  1. ```shell
  2. $ npm run start
  3. ```

The command starts a local server with the production build. Then, you can now open http://localhost:3000 with your favorite browser to see the project.

Deploy to Netlify


Clone this repository on own GitHub account and deploy to Netlify in one click:

Netlify Deploy button

During the setup, you need to define the DATABASE_URL and DATABASE_AUTH_TOKEN environment variables.

VSCode information (optional)


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.

Contributions


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.

License


Licensed under the MIT License, Copyright © 2023

See LICENSE for more information.

Sponsors


Clerk – Authentication & User Management for Next.js SQLite Developer Experience Upstash
React SaaS Boilerplate Next.js
        Add your logo here


Made with ♥ by CreativeDesignsGuru Twitter