https://github.com/khushal-ag/react-template-vitets
A Minimal ⚛️ React Starter Template with Vite, TailwindCSS, and Typescript pre-configured with ESLint and Prettier.
https://github.com/khushal-ag/react-template-vitets
eslint postcss prettier react-router react-starter-kit react-template reactjs tailwindcss type-safe typescript vite
Last synced: about 1 year ago
JSON representation
A Minimal ⚛️ React Starter Template with Vite, TailwindCSS, and Typescript pre-configured with ESLint and Prettier.
- Host: GitHub
- URL: https://github.com/khushal-ag/react-template-vitets
- Owner: Khushal-ag
- License: mit
- Created: 2023-10-05T17:40:42.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-11T19:34:29.000Z (about 1 year ago)
- Last Synced: 2025-04-11T22:09:41.862Z (about 1 year ago)
- Topics: eslint, postcss, prettier, react-router, react-starter-kit, react-template, reactjs, tailwindcss, type-safe, typescript, vite
- Language: TypeScript
- Homepage: https://react-template-vite-ts.vercel.app
- Size: 445 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
![views] ![stars] ![forks] ![issues] ![license] ![repo-size]
# React Starter Template w/ ViteTs
## A Minimal React Starter Template with Vite, TailwindCSS, and TypeScript pre-configured with ESLint and Prettier
| **Template Preview** |
| -------------------- |
| ![mockup] |
## Features
- ⚡ **[Vite](https://vitejs.dev/)** - Lightning fast frontend tooling
- ⚛️ **[React 18](https://reactjs.org/)** - A JavaScript library for building user interfaces
- 🎨 **[TailwindCSS](https://tailwindcss.com/)** - A utility-first CSS framework for rapidly building custom designs
- 📦 **[TypeScript](https://www.typescriptlang.org/)** - A typed superset of JavaScript that compiles to plain JavaScript
- 📦 **[react-router-dom](https://reactrouter.com/)** - Declarative routing for React
- 📦 **[lucide-react](https://lucide.dev/)** - Beautiful & consistent icons
- 📝 **[ESLint](https://eslint.org/)** - The pluggable linting utility for JavaScript and JSX
- ✨ **[Prettier](https://prettier.io/)** - An opinionated code formatter
- 📦 **[pnpm](https://pnpm.io/)** - Fast, disk space efficient package manager
## Getting Started
**Scaffold the project:**
```bash
pnpx degit Khushal-ag/react-template-viteTs
cd
```
**Install dependencies:**
```bash
pnpm i
```
**Initialize a new git repository _(Optional)_:**
```bash
git init
git add .
git commit -m "init"
```
## Available Scripts
In the project directory, you can run:
| **Script** | **Description** |
| ------------ | ---------------------------------------------------------------------------- |
| `dev` | Runs the app in the development mode. |
| `build` | Builds the app for production to the `dist` folder. |
| `serve` | Serves the production build from the `dist` folder. |
| `preview` | Bundles and serves the production build from the `dist` folder. |
| `type-check` | Runs TypeScript type-checking. |
| `lint` | Runs ESLint with Prettier. |
| `fix` | Runs ESLint with Prettier and fixes the errors. |
| `fmt` | Checks if the code is formatted with Prettier, if not then formats the code. |
| `fmt:check` | Checks if the code is formatted with Prettier. |
| `fmt:write` | Formats the code with Prettier. |
## After Installation Checklist
- [ ] Update `package.json` with your project details.
- [ ] Update `README.md` with your project details.
- [ ] Update `LICENSE` with your name and year.
- [ ] Update `index.html` to your liking.
- [ ] Clear `app.tsx` and write your own.
## Switching Package Manager
This template uses [pnpm](https://pnpm.io/) as the default package manager. If you want to use `npm` or `yarn`, you need to remove the `pnpm-lock.yaml` file and run `npm i` or `yarn` to generate the lock file for the respective package manager.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributors
[![][contributors]][contributors-graph]
_Note: It may take up to 24h for the [contrib.rocks][contrib-rocks] plugin to update because it's refreshed once a day._
[views]: https://komarev.com/ghpvc/?username=react-template-viteTs&label=view%20counter&color=red&style=flat
[repo-size]: https://img.shields.io/github/repo-size/Khushal-ag/react-template-viteTs
[issues]: https://img.shields.io/github/issues-raw/Khushal-ag/react-template-viteTs
[license]: https://img.shields.io/github/license/Khushal-ag/react-template-viteTs
[forks]: https://img.shields.io/github/forks/Khushal-ag/react-template-viteTs?style=flat
[stars]: https://img.shields.io/github/stars/Khushal-ag/react-template-viteTs
[contributors]: https://contrib.rocks/image?repo=Khushal-ag/react-template-viteTs&max=500
[contributors-graph]: https://github.com/Khushal-ag/react-template-viteTs/graphs/contributors
[contrib-rocks]: https://contrib.rocks/preview?repo=Khushal-ag%2Freact-template-viteTs
[mockup]: https://graph.org/file/d18be68a824517335e1eb.png