Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/up2dul/rvtgb
âī¸ A minimal React + Vite + TypeScript starter template with đ file-based routing and đ Biome for the linter + formatter
https://github.com/up2dul/rvtgb
biome boilerplate boilerplates commitlint file-based-routing generouted husky lint-staged react starter starter-kit starter-template template typescript vite
Last synced: about 2 months ago
JSON representation
âī¸ A minimal React + Vite + TypeScript starter template with đ file-based routing and đ Biome for the linter + formatter
- Host: GitHub
- URL: https://github.com/up2dul/rvtgb
- Owner: up2dul
- License: mit
- Created: 2024-06-19T04:12:41.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-06-21T13:55:20.000Z (3 months ago)
- Last Synced: 2024-06-24T12:50:47.694Z (3 months ago)
- Topics: biome, boilerplate, boilerplates, commitlint, file-based-routing, generouted, husky, lint-staged, react, starter, starter-kit, starter-template, template, typescript, vite
- Language: TypeScript
- Homepage: https://rvtgb.pages.dev
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-vite - RVTGB - `React` + `TypeScript` starter template, with file-based routing with `Generouted` and `Biome`. (Get Started / Templates)
- awesome-vite - RVTGB - `React` + `TypeScript` starter template, with file-based routing with `Generouted` and `Biome`. (Get Started / Templates)
README
âī¸ RVTGB
> âšī¸ RVTGB stands for **React Vite TypeScript Generouted Biome**.
# About
This starter template is a minimal setup to get React working with:
- ⥠[Vite](https://vitejs.dev)
- đˇ [TypeScript](https://typescriptlang.org)
- đ [Generouted](https://github.com/oedotme/generouted) â For the file-based routing
- đ [Biome](https://biomejs.dev) â Code formatter and linter
Also some additional development tools:
- đ¤ [Commitlint](https://commitlint.js.org) â Make sure the commit messages are well formatted
- đļ [Husky](https://typicode.github.io/husky) â A git hooks
- đ [Lint Staged](https://github.com/lint-staged/lint-staged) â Running some scripts before committing
> đĄ Check out [this template](https://github.com/up2dul/rvtb) instead if you prefer to use the same template without any routing library installed.
# Getting Started
## Clone this template
Clone this template using one of the following methods:
### 1. Use this repository as a template
Click the "**Use this template**" button on the top of this page to create a new repository based on this template.
> **Disclosure**: by using this repository as a template, there will be an attribution on your repository.
### 2. Clone this repository
```bash
git clone https://github.com/up2dul/rvtgb.git
# or if you have SSH keys setup
git clone [email protected]:up2dul/rvtgb.git
```
### 3. Using degit
[degit](https://github.com/Rich-Harris/degit) is a tool that allows you to quickly create a new repository based on an existing one.
```bash
npx degit up2dul/rvtgb my-new-project
```
## Usage
> Requires [Node.js](https://nodejs.org) `>=18.x`. And [pnpm](https://pnpm.io) `>=8.x` is recommended as the package manager.
### Install dependencies
Make sure you have already in the project directory.
```bash
pnpm install
```
### Run the development server
Start the development server by running the following command, and the application will be available at [http://localhost:5173](http://localhost:5173).
```bash
pnpm dev
```
# Additional informations
- Absolute paths aliases with `~`. Edit the `vite.config.ts` and `tsconfig.json` files if you want to change the aliases.
- The `src/pages` directory is the default directory for the pages, check out the [Generouted](https://github.com/oedotme/generouted) documentation for more details.
- This project is using Biome as the code formatter and linter instead of ESLint with Prettier. Edit the `biome.json` to change the configuration based on your needs, by checking out the [Biome](https://biomejs.dev) for more details.