Developer experience first, extremely flexible code structure and only keep what you need:
- β‘ Next.js with App Router support
- π₯ Type checking TypeScript
- π Integrate with Tailwind CSS
- β Strict Mode for TypeScript and React 18
- π Authentication with Next Auth: Sign up, Sign in, Sign out, Forgot password, Reset password, and more.
- π Multi-language (i18n) with next-intl and Crowdin
- β»οΈ Type-safe environment variables with T3 Env
- β¨οΈ Form with Formik
- π΄ 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
- βοΈ 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
- 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
- Node.js 18+ and npm
Run the following command on your local environment:
git clone [email protected]:Annotab-AI/annotab-next-aio-app.git
cd annotab-next-aio-app
npm install
Then, you can run locally in development mode with live reload:
npm run dev
Open http://localhost:8000 with your favorite browser to see your project.
Create a Clerk account at Clerk.com and create a new application in Clerk Dashboard. Then, copy NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY
and CLERK_SECRET_KEY
into .env.local
file (not tracked by Git):
NEXTAUTH_SECRET=your_secret_key
NEXTAUTH_SECRET=your_backend_url
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.
For translation, the project uses next-intl
combined with Crowdin. As a developer, you only need to take care of the English (or another default language) version. Other languages are automatically generated and handled by Crowdin. You can use Crowdin to collaborate with your translation team or translate the messages yourself with the help of machine translation.
To set up translation (i18n), create an account at Crowdin.com and create a new project. In the newly created project, you will able to find the project ID. You'll also require to create a new Personal Access Tokens by going to Account Settings > API. Then, in your GitHub Actions, you need to define the following environment variables CROWDIN_PROJECT_ID
and CROWDIN_PERSONAL_TOKEN
.
After defining the environment variables in your GitHub Actions, your localization files will be synchronized with Crowdin everytime you push a new commit to the main
branch.
.
βββ README.md # README file
βββ .github # GitHub folder
βββ .husky # Husky configuration
βββ .storybook # Storybook folder
βββ .vscode # VSCode configuration
βββ public # Public assets folder
βββ src
β βββ app # Next JS App (App Router)
β βββ components # React components
β βββ libs # 3rd party libraries configuration
β βββ locales # Locales folder (i18n messages)
β βββ styles # Styles folder
β βββ templates # Templates folder
β βββ types # Type definitions
β βββ utils # Utilities folder
β βββ validations # Validation schemas
βββ tests
β βββ e2e # E2E tests, also includes Monitoring as Code
β βββ integration # Integration tests
βββ tailwind.config.ts # Tailwind CSS configuration
βββ tsconfig.json # TypeScript configuration
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
andpublic/favicon-32x32.png
: your website favicon, you can generate from https://favicon.io/favicon-converter/src/utils/AppConfig.ts
: configuration filesrc/templates/BaseTemplate.tsx
: default themenext-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 π.
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 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.
All unit tests are located with the source code inside the same directory. So, it makes it easier to find them. The project uses Jest and React Testing Library for unit testing. You can run the tests with:
npm run test
The project uses Playwright for Integration and E2E testing. You can run the tests with:
npx playwright install # Only for the first time in a new environment
npm run test:e2e
The App Router folder is compatible with the Edge runtime. You can enable it by uncommenting the following lines src/app/layouts.tsx
:
// export const runtime = 'edge';
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:
$ npm run build
It generates an optimized production build of the boilerplate. For testing the generated build, you can run:
$ npm run start
You also need to defined the environment variables CLERK_SECRET_KEY
using your own key.
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.
NextJS Boilerplate comes with a built-in bundle analyzer. It can be used to analyze the size of your JavaScript bundles. To begin, run the following command:
npm run build-stats
By running the command, it'll automatically open a new browser window with the results.
Warning: webpack.cache.PackFileCacheStrategy Serializing big strings (104kiB) impacts deserialization performance (consider using Buffer instead and decode when needed)
This warning is caused by using Clerk
and next-intl
middlewares. It only happens when both middlewares are used together.
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.