Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paalamugan/next13-tailwind-boilerplate
Next.js 13 boilerplate with Tailwind CSS, TypeScript, ESLint, Prettier, Commitizen, Husky, Lint-staged, Storybook, Cypress, Semantic-release, Drizzle-kit, Drizzle-orm
https://github.com/paalamugan/next13-tailwind-boilerplate
commitizen commitlint cypress drizzle-kit drizzle-orm eslint husky lint-staged next-with-app-router next13 next13-boilerplate nextjs prettier react semantic-release storybook tailwindcss typescript
Last synced: about 5 hours ago
JSON representation
Next.js 13 boilerplate with Tailwind CSS, TypeScript, ESLint, Prettier, Commitizen, Husky, Lint-staged, Storybook, Cypress, Semantic-release, Drizzle-kit, Drizzle-orm
- Host: GitHub
- URL: https://github.com/paalamugan/next13-tailwind-boilerplate
- Owner: paalamugan
- License: mit
- Created: 2023-08-27T11:09:45.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-01T00:23:01.000Z (11 months ago)
- Last Synced: 2024-05-18T20:31:08.041Z (6 months ago)
- Topics: commitizen, commitlint, cypress, drizzle-kit, drizzle-orm, eslint, husky, lint-staged, next-with-app-router, next13, next13-boilerplate, nextjs, prettier, react, semantic-release, storybook, tailwindcss, typescript
- Language: TypeScript
- Homepage:
- Size: 1.21 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Boilerplate and Starter for Next JS 13+, Tailwind CSS 3.3 and TypeScript
🚀 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](https://clerk.com?utm_source=github&utm_medium=sponsorship&utm_campaign=nextjs-boilerplate), Database with DrizzleORM (SQLite, PostgreSQL, and MySQL) and [Turso](https://turso.tech/?utm_source=nextjsstarterbp)
### Features
Developer experience first:
- ⚡ [Next.js](https://nextjs.org) with App Router and Page Router support
- 🔥 Type checking [TypeScript](https://www.typescriptlang.org)
- 💎 Integrate with [Tailwind CSS](https://tailwindcss.com)
- ✅ Strict Mode for TypeScript and React 18
- 🔒 Authentication with [Clerk](https://clerk.com?utm_source=github&utm_medium=sponsorship&utm_campaign=nextjs-boilerplate): 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](https://turso.tech/?utm_source=nextjsstarterbp)
- ♻️ Type-safe environment variables with T3 Env
- ⌨️ Form with React Hook From
- 🔴 Validation library with Zod
- 📏 Linter with [ESLint](https://eslint.org) (default NextJS, NextJS Core Web Vitals, Tailwind CSS and Airbnb configuration)
- 💖 Code Formatter with [Prettier](https://prettier.io)
- 🦊 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
- ⌘ Database exploration with Drizzle Studio and CLI migration tool with Drizzle Kit
- ⚙️ [Bundler Analyzer](https://www.npmjs.com/package/@next/bundle-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
### 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:
```shell
git clone --depth=1 https://github.com/paalamugan/next13-tailwind-boilerplate.git my-project-name
cd my-project-name
yarn install
```
Then, you can run locally in development mode with live reload:
```shell
yarn dev
```
Open http://localhost:3000 with your favorite browser to see your project.
### Set up authentication
Create a Clerk account at [Clerk.com](https://clerk.com?utm_source=github&utm_medium=sponsorship&utm_campaign=nextjs-boilerplate) 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):
```shell
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_pub_key
CLERK_SECRET_KEY=your_clerk_secret_key
```
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](https://turso.tech/?utm_source=nextjsstarterbp). 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](https://turso.tech/?utm_source=nextjsstarterbp) and install the Turso CLI:
```shell
brew install tursodatabase/tap/turso
turso auth signup # Sign up to Turso
```
Then, create a new database:
```shell
turso db create nextjs-boilerplate
```
Now, you need to update the `DATABASE_URL` in `.env` file with the database URL provided by Turso:
```shell
turso db show nextjs-boilerplate --url
# .env
# DATABASE_URL=libsql://[RANDOM-CHARS]-[DB-NAME]-[ORG-NAME].turso.io
```
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:
```shell
turso db tokens create nextjs-boilerplate
# .env.local
# DATABASE_AUTH_TOKEN=[your-auth-token]
```
### Project structure
```shell
.
├── README.md # README file
├── __mocks__ # Mocks for testing
├── .github # GitHub folder
├── .husky # Husky configuration
├── .vscode # VSCode configuration
├── public # Public assets folder
├── src
│ ├── app # Next JS Pages (app router)
│ ├── components # React components
│ ├── layouts # Layouts components
│ ├── libs # 3rd party libraries
│ ├── models # Database models
│ ├── pages # Next JS Pages (page router)
│ ├── pages.test # Next JS Pages tests (this avoids tests to be treated as a Next.js pages)
│ ├── styles # Styles folder
│ ├── templates # Default template
│ ├── validations # Validation schemas
│ └── 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](https://www.conventionalcommits.org/) 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](https://github.com/commitizen/cz-cli), an interactive CLI that guides you through the commit process. To use it, run the following command:
```shell
yarn 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:
```shell
$ yarn build
$ yarn start
```
The generated HTML and CSS files are minified (built-in feature from Next js). It will also remove unused CSS from [Tailwind CSS](https://tailwindcss.com).
You can create an optimized production build with:
```shell
yarn build
```
Now, your blog is ready to be deployed. All generated files are located at `out` folder, which you can deploy with any hosting service.
### 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.
### Deploy to Netlify
Clone this repository on own GitHub account and deploy to Netlify:
[](https://app.netlify.com/start/deploy?repository=https://github.com/ixartz/Next-js-Boilerplate)
### Deploy to Vercel
Deploy this Next JS Boilerplate on Vercel in one click:
[](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fixartz%2FNext-js-Boilerplate)
### 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.
### License
Licensed under the MIT License, Copyright © 2023.
See [LICENSE](LICENSE) for more information.