This is a Next.js project bootstrapped with create-next-app
.
This GitHub repository serves as a starter template for building web applications using the Next.js framework. The project is configured with TypeScript, Tailwind CSS, ESLint, Prettier, Husky, Commitlint, Commitizen, Lint Staged, and uses PNPM as the package manager.
- Next.js: A React framework for building server-rendered React applications.
- TypeScript: A superset of JavaScript that adds static types.
- Tailwind CSS: A utility-first CSS framework for building modern designs.
- ESLint: A pluggable linting utility for JavaScript and TypeScript.
- Prettier: An opinionated code formatter to enforce a consistent code style.
- Husky: Enables Git hooks to run commands before commits are created.
- Commitlint: Checks if your commit messages meet the conventional commit format.
- Commitizen: Helps you write consistent commit messages.
- Lint Staged: Run linters on pre-committed files in Git.
- PNPM: A fast, disk space-efficient package manager.
If you want to use this boilerplate with the "Shadcn UI" component library, you can find an example branch at feature/with-shadcn-ui.
To integrate "Shadcn UI" into this Next.js 14 boilerplate:
-
Switch to the Shadcn UI branch:
git checkout feature/with-shadcn-ui
First, run the development server:
pnpm dev
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.
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!
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.