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 - Next Generation Frontend Tooling
• ⚛️ React 18 - A JavaScript library for building user interfaces
• 💎 TypeScript - Why not?!
• 🔨 EsLint - Pluggable JavaScript linter
• 🌀 Prettier - Opinionated Code Formatter
• 🐺 Husky - Native Git hooks
• ⚙️ Vitest - Testing library
• 📑 Commitlint - 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

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

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 asking for, we were happy to help

License

MIT