- ⚡ Next.js - A React Framework for Production
- 🔥 App Router - It is a new paradigm for building applications using React's latest features.
- 🎨 Tailwind CSS - A Utility-First CSS Framework for Rapid UI Development
- 📦 TypeScript - A typed superset of JavaScript that compiles to plain JavaScript
- 📝 ESLint - The pluggable linting utility for JavaScript and JSX
- 🛠 Prettier - An opinionated code formatter
bunx create-next-app -e "https://github.com/Khushal-ag/nextjs-template" <project-name>
Install dependencies
bun i || pnpm i || yarn || npm i
Initialize a new git repository (Optional):
git init
git add .
git commit --no-verify -m "init"
In the project directory, you can run:
Script | Description |
---|---|
dev |
Runs the app in the development mode. |
build |
Builds the app for production to the .next folder. |
start |
Runs the built app in the production mode. |
preview |
Builds and serves the app in the production mode. |
lint |
Runs next lint on the project. |
type-check |
Runs TypeScript type checker. |
fmt:check |
Checks if the code is formatted with Prettier. |
fmt |
Formats the code with Prettier. |
clean |
Remove build cache (.next). |
cleani |
Remove cache and dependencies and reinstall them. |
- Update
package.json
with your project details. - Update
README.md
with your project details. - Update
LICENSE
with your name and year. - Update
layout.tsx
to your liking. - Clear
page.tsx
and write your own.
This template uses bun as the default package manager. If you want to use npm
or yarn
or pnpm
, you need to remove the bun.lockb
file and run npm i
or yarn
or pnpm i
to generate the lock file for the respective package manager.
This project is licensed under the MIT License - see the LICENSE file for details.
Note: It may take up to 24h for the contrib.rocks plugin to update because it's refreshed once a day.