Code Monkey home page Code Monkey logo

nextui-tsr-template's Introduction

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

Deploy with Vercel

nextui-tsr-template's People

Contributors

kxxoling avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

nextui-tsr-template's Issues

TODOs

  • toast
  • fetching data
  • query
  • actions
    • PR
  • vitest
  • .env type check

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.