https://github.com/bunsdev/react-ts-vite-template
https://github.com/bunsdev/react-ts-vite-template
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/bunsdev/react-ts-vite-template
- Owner: BunsDev
- License: mit
- Created: 2021-09-08T00:29:30.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-09-08T00:29:39.000Z (almost 5 years ago)
- Last Synced: 2025-02-01T09:29:26.949Z (over 1 year ago)
- Language: TypeScript
- Homepage: react-ts-vite-template.vercel.app
- Size: 151 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# React TypeScript template with Vite
This is a [React](https://reactjs.org) + [TypeScript](https://www.typescriptlang.org/) boilerplate built with [Vite](https://vitejs.dev).
It also includes [Husky](https://typicode.github.io/husky) and a pre-commit hook that runs `npm run format`.
## What's inside?
- [ReactJS](https://reactjs.org)
- [Vite](https://vitejs.dev)
- [TypeScript](https://www.typescriptlang.org)
- [Jest](https://jestjs.io)
- [Testing Library](https://testing-library.com)
- [Cypress](https://www.cypress.io)
- [ESLint](https://eslint.org)
- [Prettier](https://prettier.io)
- [Husky](https://typicode.github.io/husky)
## Getting started
1. Create the project.
```bash
npx degit fabien-ml/react-ts-vite-template my-app
```
2. Access the project directory.
```bash
cd my-app
```
3. Initialize a git repository.
```bash
git init
```
4. Install dependencies.
```bash
npm install
```
5. Serve with hot reload at http://localhost:3000.
```bash
npm run dev
```
## Recommended VS Code extensions
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
## Other commands
### Lint commands
```bash
npm run lint
```
### Build commands
```bash
npm run build
```
### Test commands
- Run tests
```bash
npm run test
```
- Watch tests
```bash
npm run test:watch
```
- Run e2e tests with cypress
```bash
npm run test:e2e
```
## License
This project is licensed under the MIT License.