Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rajput-hemant/react-template-vite
A Minimal ⚛️ React Starter Template with Vite, TailwindCSS, and Typescript pre-configured with ESLint, Prettier and Husky.
https://github.com/rajput-hemant/react-template-vite
bun-react bun-vite bunjs eslint husky prettier react react-router react-router-dom react-starter-kit react-template tailwindcss tanstack-router typescript vite
Last synced: 24 days ago
JSON representation
A Minimal ⚛️ React Starter Template with Vite, TailwindCSS, and Typescript pre-configured with ESLint, Prettier and Husky.
- Host: GitHub
- URL: https://github.com/rajput-hemant/react-template-vite
- Owner: rajput-hemant
- License: mit
- Created: 2023-06-13T05:26:01.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-13T09:44:12.000Z (7 months ago)
- Last Synced: 2024-04-13T21:47:13.929Z (7 months ago)
- Topics: bun-react, bun-vite, bunjs, eslint, husky, prettier, react, react-router, react-router-dom, react-starter-kit, react-template, tailwindcss, tanstack-router, typescript, vite
- Language: TypeScript
- Homepage: https://react-template.rajputhemant.me
- Size: 938 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![ntl-badge]][ntl-link] ![ci] ![views] ![stars] ![forks] ![issues] ![license] ![repo-size]
# React Starter Template w/ Vite
### A Minimal React Starter Template with Vite, TailwindCSS, and TypeScript pre-configured with ESLint, Prettier and Husky.
## 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
- 📦 **[TanStack Router](https://tanstack.com/router)** - A fully type-safe React router with built-in data fetching, stale-while revalidate caching and first-class search-param APIs.
- 📦 **[react-router](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
- 🐶 **[Husky](https://typicode.github.io/husky/#/)** - Git hooks made easy
- 🚫 **[lint-staged](https://github.com/okonet/lint-staged)** - Run linters against staged git files
- 📄 **[commitlint](https://commitlint.js.org/#/)** - Lint commit messages
- 📦 **[bun](https://bun.sh)** - A JavaScript runtime w/ Fast, disk space efficient package manager
## Getting Started
**Install `degit` globally:**
```bash
bun i -g degit || pnpm i -g degit || yarn global add degit || npm i -g degit
```
**Scaffold the project:**
```bash
# basic template w/ react-router-dom
degit rajput-hemant/react-template-vite
cd
```
```bash
# basic template w/ tanstack-router
degit rajput-hemant/react-template-vite#tanstack-router
cd
```
```bash
# barebone template
degit rajput-hemant/react-template-vite#barebone
cd
```
**Install dependencies:**
```bash
bun i || pnpm i || yarn || npm i
```
**Initialize a new git repository _(Optional)_:**
```bash
git init
git add .
git commit --no-verify -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. |
| `fmt` | Formats the code with Prettier. |
| `fmt:check` | Checks if the code is formatted with Prettier. |
| `prepare` | Installs husky git hooks. |
## 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.
## Switching Package Manager
This template uses [bun](https://bun.sh) as the default package manager. If you want to use `pnpm`, `npm` or `yarn`, you need to remove the `bun.lockb` file and run `pnpm i`, `npm i` or `yarn` to generate the lock file for the respective package manager.
## Deployments
[](https://vercel.com/new/git/external?repository-url=https://github.com/rajput-hemant/react-template-vite)
[](https://app.netlify.com/start/deploy?repository=https://github.com/rajput-hemant/react-template-vite)
## 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-vite&label=view%20counter&color=red&style=flat
[repo-size]: https://img.shields.io/github/repo-size/rajput-hemant/react-template-vite
[issues]: https://img.shields.io/github/issues-raw/rajput-hemant/react-template-vite
[license]: https://img.shields.io/github/license/rajput-hemant/react-template-vite
[forks]: https://img.shields.io/github/forks/rajput-hemant/react-template-vite?style=flat
[stars]: https://img.shields.io/github/stars/rajput-hemant/react-template-vite
[contributors]: https://contrib.rocks/image?repo=rajput-hemant/react-template-vite&max=500
[contributors-graph]: https://github.com/rajput-hemant/react-template-vite/graphs/contributors
[contrib-rocks]: https://contrib.rocks/preview?repo=rajput-hemant%2Freact-template-vite
[ci]: https://github.com/rajput-hemant/react-template-vite/actions/workflows/ci.yml/badge.svg
[ntl-badge]: https://api.netlify.com/api/v1/badges/1699cfdd-9493-4c43-97de-0ec96fa4e1a1/deploy-status
[ntl-link]: https://app.netlify.com/sites/react-template-vite/deploys