README.md

NextUI + TanStack router + Tailwind CSS + TypeScript Starter and Boilerplate

Features

This repository is 🔋 battery packed with:

• ⚛️ React 18
• ⚡️ File router powered by TanStack Router
• ✨ TypeScript
• ⚡️ Stylish NextUI created by @vercel inc.
• 💨 Tailwind CSS
• Vite - ⚡️ Fast Refresh, HMR, and Bundling
• 🃏 Vitest — Configured for unit testing
• 📈 Absolute Import and Path Alias — Import components using @/ prefix
• Pre-configured Code Formatters
  • 📏 ESLint
  • 💖 Prettier
  • 🐶 Husky & Lint Staged
  • 🤖 Conventional Commit Lint
• 👷 Github Actions — Lint your code on PR
• 📝 MIT License

Getting Started

Clone this template using one of the three ways

• Use this repository as template

  Disclosure: by using this repository as a template, there will be an attribution on your repository.

  I'll appreciate if you do, so this template can be known by others too 😄

  Use this template

Install dependencies

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

pnpm install

Run the development server

You can start the server using this command:

pnpm dev

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

Commit Message Convention

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

Test

UI

npx vite preview --outDir ./html

Deploy

Build

pnpm build

Deploy to Vercel