Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liaoyio/nextjs-template
一个 Next.js 开发模板，集成 TypeScript, TailwindCSS, ESLint, Prettier, Husky git hooks.
https://github.com/liaoyio/nextjs-template
eslint husky-hooks nextjs prettier tailwindcss typescript
Last synced: 1 day ago
JSON representation
一个 Next.js 开发模板，集成 TypeScript, TailwindCSS, ESLint, Prettier, Husky git hooks.
- Host: GitHub
- URL: https://github.com/liaoyio/nextjs-template
- Owner: liaoyio
- Created: 2024-01-09T07:16:34.000Z (about 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-01-14T07:36:11.000Z (about 1 year ago)
- Last Synced: 2024-01-14T15:06:15.961Z (about 1 year ago)
- Topics: eslint, husky-hooks, nextjs, prettier, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://nextjs-template-liaoyi.vercel.app
- Size: 1.31 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
![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/liaoyio/nextjs-template"
npx create-next-app -e "https://github.com/liaoyio/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 liaoyio/nextjs-template
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"
```
## 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. |
| `lint:lint-staged` | Runs lint-staged |
| `commit` | Runs git-cz |
## 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.