Skip to content

yscoder310/create-dev-vite

Repository files navigation

Vite React TypeScript Starter

Vite React TypeScript ESLint Prettier Jest React Testing Library Husky Lint-staged

A starter template for a Vite React project with TypeScript, ESLint, Prettier, Jest, and pre-commit linting and formatting using Husky.

Features

  • ⚡️ Vite 4.x: Blazing fast frontend tooling.
  • ⚛️ React 18.x: A declarative, efficient, and flexible JavaScript library for building user interfaces.
  • 🦄 TypeScript 4.x: Typed JavaScript at Any Scale.
  • 🚀 ESLint: Pluggable linting utility for JavaScript and TypeScript.
  • 💅 Prettier: Opinionated code formatter.
  • 🃏 Jest: Delightful JavaScript Testing.
  • 🕵️ React Testing Library: Simple and complete testing utilities.
  • 🐶 Husky: Modern native Git hooks made easy.
  • 🧹 Lint-staged: Run linters on pre-committed files.

Getting Started

  1. Clone the repository:

    git clone https://github.com/ysinghal310/vite-react-boilerplate
  2. Install dependencies:

    cd your-vite-react-ts-project
    yarn install or npm install
  3. Run the development server:

    yarn dev or npm run dev
  4. Lint and format code:

    yarn lint or npm run lint
  5. Run tests:

    yarn test or npm run test

Commands

  • yarn dev or npm run dev: Start the development server.
  • yarn build or npm run build: Build the project for production.
  • yarn lint or npm run lint: Lint the project using ESLint and format code using Prettier.
  • yarn test or or npm run test: Run tests using Jest.
  • yarn test:watch : or npm run test:watch: Run tests in watch mode.

Contributing

Feel free to contribute to this project. Create an issue or submit a pull request if you find any bugs or improvements.

License

This project is licensed under the MIT License - see the LICENSE file for details.