Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rajput-hemant/nextjs-template
A Minimal Next.js Starter Template with TypeScript, Tailwind CSS, and pre-configured with ESLint, Prettier, and Husky.
https://github.com/rajput-hemant/nextjs-template
bun-nextjs bunjs eslint husky nextjs nextjs-boilerplate nextjs-starter nextjs-template nextjs13 nextjs14 tailwindcss typescript
Last synced: 3 days ago
JSON representation
A Minimal Next.js Starter Template with TypeScript, Tailwind CSS, and pre-configured with ESLint, Prettier, and Husky.
- Host: GitHub
- URL: https://github.com/rajput-hemant/nextjs-template
- Owner: rajput-hemant
- License: mit
- Created: 2023-06-13T10:18:05.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-12T16:54:36.000Z (6 months ago)
- Last Synced: 2024-04-14T02:04:43.399Z (6 months ago)
- Topics: bun-nextjs, bunjs, eslint, husky, nextjs, nextjs-boilerplate, nextjs-starter, nextjs-template, nextjs13, nextjs14, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://nextjs-template.rajputhemant.me
- Size: 1.29 MB
- Stars: 26
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![ntl-badge]][ntl-link] ![views] ![stars] ![forks] ![issues] ![license] ![repo-size]
![Next.js]()
# Next.js Starter Template
### A Minimal Next.js Starter Template with TypeScript, Tailwind CSS, and pre-configured with ESLint, Prettier, and Husky.
## Features
- ⚡ **[Next.js](https://nextjs.org/)** - A React Framework for Production
- 🔥 **[App Router](https://nextjs.org/docs/app)** - It is a new paradigm for building applications using React's latest features.
- 🎨 **[Tailwind CSS](https://tailwindcss.com/)** - A Utility-First CSS Framework for Rapid UI Development
- 📦 **[TypeScript](https://www.typescriptlang.org/)** - A typed superset of JavaScript that compiles to plain JavaScript
- 📝 **[ESLint](https://eslint.org/)** - The pluggable linting utility for JavaScript and JSX
- 🛠 **[Prettier](https://prettier.io/)** - An opinionated code formatter
- 🐶 **[Husky](https://typicode.github.io/husky/#/)** - A tool that makes Git hooks easy
- 🚫 **[lint-staged](https://github.com/okonet/lint-staged)** - Run linters against staged git files
- 📄 **[commitlint](https://commitlint.js.org/#/)** - Lint commit messages
- 📦 **[bun](https://bun.sh)** - A JavaScript runtime w/ Fast, disk space efficient package manager
## Getting Started
```bash
bun create next-app -e "https://github.com/rajput-hemant/nextjs-template"
npx create-next-app -e "https://github.com/rajput-hemant/nextjs-template"
```
OR
**Install `degit` globally**
```bash
bun i -g degit || pnpm i -g degit || yarn global add degit || npm i -g degit
```
**Create a new project from this template**
```bash
degit rajput-hemant/nextjs-template
# src directory
degit rajput-hemant/nextjs-template#src-dir
# tRPC
degit rajput-hemant/nextjs-template#trpc
cd
```
**Install dependencies**
```bash
bun i || pnpm i || yarn || npm i
```
**Initialize a new git repository _(Optional)_:**
```bash
git init
git add .
git commit --no-verify -m "init"
```
## Integrations
[Kirimase](https://kirimase.dev) is a Next.js CLI tool that accelerates full-stack app development. It seamlessly integrates packages like ORM (Prisma or Drizzle), authentication (Auth.js, Clerk, Lucia, Kinde), UI components (Shadcn-UI), payments (Stripe), and email (Resend), following best practices.
To add integrations to your project, run:
```bash
kirimase init
```
## Available Scripts
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` | Formats the code with Prettier. |
| `fmt:check` | Checks if the code is formatted with Prettier. |
| `prepare` | Installs husky git hooks. |
## After Installation Checklist
- [ ] Update `package.json` with your project details.
- [ ] Update `README.md` with your project details.
- [ ] Update `LICENSE` with your name and year.
## Switching Package Manager
This template uses [bun](https://bun.sh/docs/cli/install) as the default package manager. If you want to use `pnpm`, `npm` or `yarn`, you need to remove the `bun.lockb` file and run `pnpm i`, `npm i` or `yarn` to generate the lock file for the respective package manager.
## Deployments
[](https://vercel.com/new/git/external?repository-url=https://github.com/rajput-hemant/nextjs-template)
[](https://app.netlify.com/start/deploy?repository=https://github.com/rajput-hemant/nextjs-template)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributors:
[![][contributors]][contributors-graph]
_Note: It may take up to 24h for the [contrib.rocks][contrib-rocks] plugin to update because it's refreshed once a day._
[views]: https://komarev.com/ghpvc/?username=nextjs-template&label=view%20counter&color=red&style=flat
[repo-size]: https://img.shields.io/github/repo-size/rajput-hemant/nextjs-template
[issues]: https://img.shields.io/github/issues-raw/rajput-hemant/nextjs-template
[license]: https://img.shields.io/github/license/rajput-hemant/nextjs-template
[forks]: https://img.shields.io/github/forks/rajput-hemant/nextjs-template?style=flat
[stars]: https://img.shields.io/github/stars/rajput-hemant/nextjs-template
[contributors]: https://contrib.rocks/image?repo=rajput-hemant/nextjs-template&max=500
[contributors-graph]: https://github.com/rajput-hemant/nextjs-template/graphs/contributors
[contrib-rocks]: https://contrib.rocks/preview?repo=rajput-hemant%2Fnextjs-template
[ntl-badge]: https://api.netlify.com/api/v1/badges/6955f80c-0747-4947-a344-e7c647012cbe/deploy-status
[ntl-link]: https://app.netlify.com/sites/react-template-vite/deploys