Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 2.1 KB

README.md

File metadata and controls

57 lines (40 loc) · 2.1 KB

🔋 TDD - TEMPLATE

Next.js + Redux + Tailwind CSS + TypeScript

Features

This repository is 🔋 battery packed with:

  • ⚡️ Next.js 13
  • ⚛️ React 18
  • ✨ TypeScript
  • ⚛️ Redux 8.0.5(next-redux-wrapper, redux-persist, redux-thunk)
  • ✨ Sass
  • 💨 Tailwind CSS 3 — Configured with CSS Variables to extend the primary color
  • 📈 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 on PR
  • 🚘 Automatic Branch and Issue Autolink — Branch will be automatically created on issue assign, and auto linked on PR
  • 🗺 Site Map — Automatically generate sitemap.xml
  • 📦 Expansion Pack — Easily install common libraries, additional components, and configs

Getting Started

1. Install dependencies

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

yarn install

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

Are you using this starter? Please add your page (and repo) to the end of the list via a Pull Request. 😃