Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kxxoling/nextui-tsr-template
Another React starter template based on nextui, tanstack-router, vite, vitest, TailwindCSS.
https://github.com/kxxoling/nextui-tsr-template
nextui react tailwindcss tanstack-router typescript vite vitest
Last synced: 2 months ago
JSON representation
Another React starter template based on nextui, tanstack-router, vite, vitest, TailwindCSS.
- Host: GitHub
- URL: https://github.com/kxxoling/nextui-tsr-template
- Owner: kxxoling
- Created: 2024-01-04T18:25:22.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-01-11T09:28:57.000Z (12 months ago)
- Last Synced: 2024-10-04T15:43:31.461Z (3 months ago)
- Topics: nextui, react, tailwindcss, tanstack-router, typescript, vite, vitest
- Language: TypeScript
- Homepage: https://nextui-tsr-template.vercel.app/
- Size: 118 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# NextUI + TanStack router + Tailwind CSS + TypeScript Starter and Boilerplate
## Features
This repository is 🔋 battery packed with:
- ⚛️ React 18
- ⚡️ File router powered by [TanStack Router](https://tanstack.com/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](https://github.com/new?template_name=nextui-tsr-template&template_owner=kxxoling)
### Install dependencies
It is encouraged to use **pnpm** so the husky hooks can work properly.
```bash
pnpm install
```
### Run the development server
You can start the server using this command:
```bash
pnpm dev
```
Open [http://localhost:5173](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](https://www.conventionalcommits.org/en/v1.0.0/), it is mandatory to use it to commit changes.
## Test
### UI
```sh
npx vite preview --outDir ./html
```
## Deploy
### Build
```sh
pnpm build
```
### Deploy to Vercel
[](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fkxxoling%2Fnextui-tsr-template)