Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/code-sensei/nextjs-template

A robust Next.js template to kickstart your web projects. This template includes essential tools and configurations to streamline development.
https://github.com/code-sensei/nextjs-template

eslint husky nextjs nextjs13 nextjs14 postcss react reactjs tailwindcss

Last synced: 9 days ago
JSON representation

A robust Next.js template to kickstart your web projects. This template includes essential tools and configurations to streamline development.

Awesome Lists containing this project

README

        

# Next.js Template
---

A robust Next.js template to kickstart your web projects. This template includes essential tools and configurations to streamline development.

## Features

- **Next.js**: The React framework for production.
- **TypeScript**: For static type checking.
- **Tailwind CSS**: Utility-first CSS framework.
- **ESLint**: Linting utility to maintain code quality.
- **Prettier**: Code formatter to ensure consistent styling.
- **Husky**: Git hooks to enforce quality checks.
- **PostCSS**: Tool for transforming CSS with JavaScript plugins.

## Getting Started

### Prerequisites

- Node.js
- npm, yarn, pnpm, or bun

### Installation

Clone the repository:

```bash
git clone https://github.com/code-sensei/nextjs-template.git
cd nextjs-template
```

Install dependencies:

```bash
npm install
# or
yarn install
# or
pnpm install
# or
bun install
```

### Development

Run the development server:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

Open [http://localhost:3000](http://localhost:3000) to view it in your browser. The page auto-updates as you make edits.

### Building for Production

To create an optimized production build:

```bash
npm run build
# or
yarn build
# or
pnpm build
# or
bun build
```

### Linting and Formatting

Lint your code with:

```bash
npm run lint
# or
yarn lint
# or
pnpm lint
# or
bun lint
```

Format your code with:

```bash
npm run format
# or
yarn format
# or
pnpm format
# or
bun format
```

### Commit Hooks

This template uses Husky to run linting and formatting checks before each commit.

### Learn More

- [Next.js Documentation](https://nextjs.org/docs)
- [Learn Next.js](https://nextjs.org/learn)
- [Tailwind CSS Documentation](https://tailwindcss.com/docs)

## Contributing

Feel free to fork this repository, create a branch, and submit a pull request.

## License

This project is licensed under the MIT License.