https://github.com/nzambello/vite-react-template
Template for a React project with Vite, TS, Vitest, Playwright, Storybook, ESLint, StyleLint and Husky
https://github.com/nzambello/vite-react-template
boilerplate hacktoberfest playwright react storybook template typescript vite vitejs vitest
Last synced: 9 months ago
JSON representation
Template for a React project with Vite, TS, Vitest, Playwright, Storybook, ESLint, StyleLint and Husky
- Host: GitHub
- URL: https://github.com/nzambello/vite-react-template
- Owner: nzambello
- License: mit
- Created: 2022-10-05T09:56:25.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-05T14:26:18.000Z (about 3 years ago)
- Last Synced: 2025-01-09T10:49:35.990Z (11 months ago)
- Topics: boilerplate, hacktoberfest, playwright, react, storybook, template, typescript, vite, vitejs, vitest
- Language: TypeScript
- Homepage:
- Size: 405 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# vite-react-template
This is a [React](https://reactjs.org) + [TypeScript](https://www.typescriptlang.org/) boilerplate built with [Vite](https://vitejs.dev).
## What's inside?
- [ReactJS](https://reactjs.org)
- [Vite](https://vitejs.dev)
- [TypeScript](https://www.typescriptlang.org)
### Linting and formatting
- [Prettier](https://prettier.io)
- [ESLint](https://eslint.org)
- [StyleLint](https://stylelint.io/)
- [Husky](https://typicode.github.io/husky/#/)
- [Commitlint](https://commitlint.js.org/#/)
### Testing
- [Vitest](https://vitest.dev/)
- [Testing Library](https://testing-library.com)
- [Playwright](https://playwright.dev/)
### Misc
- [Storybook](https://storybook.js.org)
- [Release-it](https://github.com/release-it/release-it)
- [GitHub Actions](https://github.com/nzambello/vite-react-template/actions)
### Make it yours
In the `package.json` file, check `release-it`, `eslint`, `stylelint` and `prettier` configurations and change the values to match your project and your preferences.
## Getting started
1. Create the project.
```bash
npx degit nzambello/vite-react-template my-app
```
2. Access the project directory.
```bash
cd my-app
```
3. Initialize a git repository.
```bash
git init
```
4. Install dependencies.
```bash
yarn
```
5. Start dev server with hot reload at http://localhost:3000.
```bash
yarn dev
```
## Other commands
### Lint commands
```bash
yarn lint
# or separately
yarn lint:js
yarn lint:css
```
### Type check
```bash
yarn typecheck
```
### Format with prettier
```bash
yarn format
```
### Build commands
```bash
yarn build
```
### Run the app in production mode at http://localhost:3000.
```bash
yarn preview
```
### Component stories
```bash
yarn storybook
```
### Test commands
- Run unit tests and watch
```bash
yarn test
```
- Run unit tests with coverage
```bash
yarn coverage
```
- Run e2e tests
```bash
yarn test:e2e
```
- Run e2e tests in debug mode
```bash
yarn test:e2e:debug
```
- Show e2e tests results
```bash
yarn playwright show-report
```
## License
This project is licensed under the MIT License.
## Credits
This project was heavily inspired by [react-ts-vite-template](https://github.com/fabien-ml/react-ts-vite-template/).