Skip to content

typescript, tailwind, recoil, prettier, eslint, husky and shadcn

Notifications You must be signed in to change notification settings

johnsus1995/next-starter

Repository files navigation

Next.js + Tailwind CSS + TypeScript Starter and Boilerplate

Getting Started

1. Install dependencies

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

pnpm install
pnpm prepare

2. Run the development server

You can start the server using this command:

pnpm dev

Open http://localhost:3000 with your browser to see the result. You can start editing the page by modifying src/pages/index.tsx.

3. 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

4. Commit Message Convention

This starter is using conventional commits, it is mandatory to use it to commit changes.