Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sakilk130/nextjs-13-boilerplate

🚀🚀🚀 Boilerplate and Starter for Next.js 13+, Tailwind CSS & TypeScript Made with developer experience first: Next.js + TypeScript + ESLint + Prettier + Husky + Lint-Staged + Jest + Testing Library + Cypress + Commitlint + VSCode + PostCSS + Tailwind CSS
https://github.com/sakilk130/nextjs-13-boilerplate

boilerplate boilerplate-front-end boilerplate-template eslint jamstack js-boilerplate next-js next-js-template next-theme nextjs postcss seo starter-kit starter-template static-site static-site-generator tailwind-css tailwindcss typescript

Last synced: 16 days ago
JSON representation

🚀🚀🚀 Boilerplate and Starter for Next.js 13+, Tailwind CSS & TypeScript Made with developer experience first: Next.js + TypeScript + ESLint + Prettier + Husky + Lint-Staged + Jest + Testing Library + Cypress + Commitlint + VSCode + PostCSS + Tailwind CSS

Awesome Lists containing this project

README

        

# Boilerplate and Starter for Next JS 13+, Tailwind CSS and TypeScript


🚀🚀 nextjs-13-boilerplate


Next.js + Tailwind CSS + TypeScript starter packed with useful development features.


Made by Sakil Khan

[![GitHub Repo stars](https://img.shields.io/github/stars/sakilk130/nextjs-13-boilerplate)](https://github.com/sakilk130/nextjs-13-boilerplate/stargazers)

## Features

This repository is 🔋 battery packed with:

- ⚡️ Next.js 13
- ⚛️ React 18
- ✨ TypeScript
- 💨 Tailwind CSS
- 🃏 Jest — Configured for unit testing
- 📈 Absolute Import and Path Alias — Import components using `@/` prefix
- 📏 ESLint — Find and fix problems in your code, also will **auto sort** your imports
- 💖 Prettier — Format your code consistently
- 🐶 Husky & Lint Staged — Run scripts on your staged files before they are committed
- 🤖 Conventional Commit Lint — Make sure you & your teammates follow conventional commit
- ⏰ Release Please — Generate your changelog by activating the `release-please` workflow
- 👷 Github Actions — Lint your code
- 🔥 Snippets — A collection of useful snippets
- 📦 Expansion Pack — Easily install common libraries, additional components, and configs

## Getting Started

### 1. Clone this template

```bash
git clone https://github.com/sakilk130/nextjs-13-boilerplate.git
```

### 2. Install dependencies

It is encouraged to use **yarn** so the husky hooks can work properly.

```bash
npm install
```

### 3. Run the development server

You can start the server using this command:

```bash
npm run dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. You can start editing the page by modifying `src/app/page.tsx`.

### 4. Change defaults

There are some things you need to change including title, urls, favicons, etc.

Find all comments with !STARTERCONF, then follow the guide.

Don't forget to change the package name in package.json

### 5. Commit Message Convention

This starter is using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), it is mandatory to use it to commit changes.

Are you using this starter? Please add your page (and repo) to the end of the list via a [Pull Request](https://github.com/sakilk130/nextjs-13-boilerplate/edit/main/README.md). 😃