README.md

🔋 ts-nextjs-chakra-starter

Next.js + Chakra-UI + TypeScript starter packed with useful development features.

Features

This repository is 🔋 battery packed with:

• ⚡️ Next.js 12
• ⚛️ React 17
• ✨ TypeScript
• 💨 Chakra-UI
• 🃏 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
• ⏰ Standard Version Changelog — Generate your changelog using yarn release
• 👷 Github Actions — Lint your code on PR
• 🚘 Automatic Branch and Issue Autolink — Branch will be automatically created on issue assign, and auto linked on PR
• 🔥 Snippets — A collection of useful snippets

Getting Started

1. Clone this template using one of the three ways:

1. Using create-next-app

   npx create-next-app -e https://github.com/revell29/ts-nextjs-chakra-starter project-name

2. Deploy to Vercel

   

2. Install dependencies

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

yarn install

3. Run the development server

You can start the server using this command:

yarn dev

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

4. Change defaults

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

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

5. Commit Message Convention

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