Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patrickjmeurer/viterc
A modern minimal Vite + React + TypeScript template with pre-configured ESLint (with Airbnb JS/React rules), Prettier, Testing with Jest and Git hooks with Husky out of the box 📦
https://github.com/patrickjmeurer/viterc
eslint prettier react template typescript vite vite-template vite-template-react vitejs
Last synced: 11 days ago
JSON representation
A modern minimal Vite + React + TypeScript template with pre-configured ESLint (with Airbnb JS/React rules), Prettier, Testing with Jest and Git hooks with Husky out of the box 📦
- Host: GitHub
- URL: https://github.com/patrickjmeurer/viterc
- Owner: patrickjmeurer
- Created: 2022-07-15T18:05:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-29T21:31:33.000Z (11 months ago)
- Last Synced: 2024-08-10T06:01:17.433Z (3 months ago)
- Topics: eslint, prettier, react, template, typescript, vite, vite-template, vite-template-react, vitejs
- Language: TypeScript
- Homepage: https://viterc.netlify.app/
- Size: 48.8 KB
- Stars: 54
- Watchers: 1
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ViteRC ❤️🔥
A modern minimal Vite 5 + React 18 + TypeScript template with pre-configured ESLint (with Airbnb JS/React rules), Prettier, Vitest and Git hooks with Husky out of the box 📦
## Features
- ⚡️ [Vite 5](https://vitejs.dev/) - Next Generation Frontend Tooling
- ⚛️ [React 18](https://reactjs.org/) - A JavaScript library for building user interfaces
- 💎 [TypeScript](https://www.typescriptlang.org/) - Why not?!
- 🔨 [EsLint](https://eslint.org/) - Pluggable JavaScript linter
- 🌀 [Prettier](https://prettier.io) - Opinionated Code Formatter
- 🐺 [Husky](https://github.com/typicode/husky) - Native Git hooks
- ⚙️ [Vitest](https://vitest.dev/guide/) - Testing library
- 📑 [Commitlint](https://commitlint.js.org/) - Linting your commits based on commit convention
- ⌨️ Absolute Imports
## Why
This template arose out of a need to unite all the above libraries, which were not found in the existing Vite templates. This template has an active contributors that will update everything on this template as needed
## Usage
If you are using either Yarn or NPM run the command bellow
```bash
npx degit potreco/viterc my-app
cd my-app
# Required if you want a repository and work with Git hooks
git init
yarn install
yarn dev
```
If you are using Bun
```bash
bun create potreco/viterc/bun my-app
cd my-app
# Required if you want a repository and work with Git hooks
git init
bun install
bun run dev
```
## Available commands
In this project, you can run the following scripts:
| Script | Description |
| ---------- | --------------------------------------------------------------------------- |
| dev | Runs the app in the development mode. |
| build | Builds the app for production to the `dist` folder. |
| lint | Runs the Eslint and show code problems |
| format | Runs the Prettier and fix code style |
| preview | Builds the app for production to the `dist` folder, and run locally server. |
| test | Run the app tests. |
| test:watch | Run the app tests in watch mode. |
## About the absolute imports
To correctly functioning (code and tests) of absolute imports, you should add some codes in some files, like:
- vite.config.ts
- tsconfig.json
We already writed some absolute imports on these files, so if you wanna more paths or edit some, feel free to do it.
If your not safe about it or have some question, send us a thread on [Github Discussions](https://github.com/potreco/viterc/discussions/new?category=q-a) asking for, we were happy to help
## License
[MIT](https://choosealicense.com/licenses/mit/)