Next.js Starter Template with TailwindCSS, TypeScript et al

This repo contains an opinionated starter template for Next.js pre-installed and configured with the following:

• TailwindCSS for styling: https://tailwindcss.com/docs
• ESLint for code linting: https://eslint.org
• Prettier for code formating: https://prettier.io/
• Husky for handling git hooks: https://typicode.github.io/husky/#/
• Lint-Staged for formatting, linting & type-checking staged files: https://github.com/okonet/lint-staged
• Commitizen & respective plugins for linting commits: https://github.com/commitizen

Getting Started

Run the following command to get started with a new project using this template:

npx create-next-app [project-name] -e https://github.com/atreya2011/next-tailwind-ts-template
# or
yarn create next-app [project-name] -e https://github.com/atreya2011/next-tailwind-ts-template

Run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

Caveats

• To make husky & lint-staged work after creating a new project using this template, run the following command:

npm rebuild
# or
yarn --force
# or
npm rebuild --update-binary # (if yarn --force doesn't work)

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.