A boilerplate project for building modern web applications using React, Vite, TypeScript, ESLint, Prettier, Husky, Vitest, and GitHub Actions.
- React: A popular JavaScript library for building user interfaces.
- Vite: A fast, modern development build tool.
- TypeScript: A statically typed superset of JavaScript.
- ESLint: A pluggable linting utility for JavaScript and TypeScript.
- Prettier: An opinionated code formatter.
- Husky: Git hooks made easy.
- Vitest: A simple, lightweight, and fast testing framework.
- GitHub Actions: Automate your workflow with CI/CD.
Get your project up and running with the following steps:
Before you begin, ensure you have met the following requirements:
- Node 18
- Yarn
-
Fork and clone the repo
git clone git@github.com:VinayakSuthar/react-ts-boilerplate.git
-
Install Dependencies
yarn
-
Run development server
yarn run dev
yarn run dev
start Vite dev server in the current directory atlocalhost:5173
.yarn run lint
to lint your code.yarn run format
to automatically format your code with Prettier.yarn run build
generates a production-ready bundle.
Note
To make sure that Eslint and Prettier run before every commit, run the commandyarn run prepare
after setting up your project.
This project is set up for continuous integration using GitHub Actions. The CI pipeline includes running tests and deploying to Github Pages. You can view the CI/CD workflows in the .github/workflows directory.