Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aulianza/vite-react-starter
⚡️ Vite + React + TypeScript + Tailwind CSS starter template
https://github.com/aulianza/vite-react-starter
boilerplate commitlint eslint prettier react starter-template tailwindcss typescript vite
Last synced: 10 days ago
JSON representation
⚡️ Vite + React + TypeScript + Tailwind CSS starter template
- Host: GitHub
- URL: https://github.com/aulianza/vite-react-starter
- Owner: aulianza
- License: mit
- Created: 2023-07-05T06:40:41.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-08T19:05:26.000Z (30 days ago)
- Last Synced: 2024-10-21T04:53:21.349Z (17 days ago)
- Topics: boilerplate, commitlint, eslint, prettier, react, starter-template, tailwindcss, typescript, vite
- Language: TypeScript
- Homepage: https://vite-react-starter.aulianza.id
- Size: 199 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
vite-react-starter
⚡️ Vite + React + TypeScript + Tailwind CSS starter template
## Introduction
Introducing a simple Vite with React + Typescript and Tailwind CSS starter template. This custom-made template has been carefully designed to simplify complex configurations and time-consuming setups, allowing developers (me; especially) to focus on my work effortlessly.
If you find this amazing creation valuable, you're invited to use it for your own projects. I warmly welcome any helpful feedback or suggestions you may have. You can easily make your own version by copying or downloading this code repository and contribute your own fantastic ideas by submitting a Pull Request.
## Features
This repository is packed with:
- ⚡️ Vite 4.3
- ⚛️ React 18
- 🔰 TypeScript
- 💠 Tailwind CSS 3
- 🛢 Jest — Configured for unit testing
- 🧿 Absolute Import and Path Alias — Import components using `@/` prefix
- 📏 ESLint — Find and fix problems in the code, also will **auto sort** the imports
- ✨ Prettier — Format your code consistently
- 🐶 Husky & Lint Staged — Run scripts on your staged files before committed
- 📌 Conventional Commit Lint — Make sure to follow conventional commit
- ♻️ Snippets — A collection of most useful snippets
- 🌚 Dark Mode & Light Mode - Switch theme just one click
## Getting Started
### 1. Clone this template using one of the three ways:
1. Use this repository as template
2. Using `degit`
```bash
npx degit aulianza/vite-react-starter YOUR_APP_NAME
```
3. Deploy to Vercel or Netlify, etc
[](https://vercel.com/new/git/external?repository-url=https://github.com/aulianza/vite-react-starter)
[](https://app.netlify.com/start/deploy?repository=https://github.com/aulianza/vite-react-starter)
### 2. Install dependencies
It is encouraged to use **pnpm** so the husky hooks can work properly.
```bash
pnpm install
```
### 3. 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/App.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](https://www.conventionalcommits.org/en/v1.0.0/), it is mandatory to use it to commit changes.
## License
Licensed under the [MIT license](https://github.com/aulianza/vite-react-starter/blob/master/LICENSE).