Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidyang2149/react-starter
React Starter Kit
https://github.com/davidyang2149/react-starter
react starter-kit typescript
Last synced: about 1 month ago
JSON representation
React Starter Kit
- Host: GitHub
- URL: https://github.com/davidyang2149/react-starter
- Owner: DavidYang2149
- License: mit
- Created: 2022-05-25T13:52:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-19T10:00:12.000Z (over 1 year ago)
- Last Synced: 2024-09-12T20:12:11.335Z (2 months ago)
- Topics: react, starter-kit, typescript
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@davidyang2149/react-starter
- Size: 15.3 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React Starter
- GitHub: [React starter kit](https://github.com/DavidYang2149/react-starter)
- npm: [Download](https://www.npmjs.com/package/@davidyang2149/react-starter)
## 🚀 Quick start
```sh
npx @davidyang2149/react-starter
```
## 💎 Tech stack
- TypeScript
- ESLint
- Vite
- React
- Jest
- Testing-Library
- Cypress
## 📚 Install dependencies
```sh
npm install
```
## 💻 Run dev server
```sh
npm run start
```
## 🧪 TypeScript check
```sh
npm run check
```
## 🧪 ESLint check
```sh
npm run lint
```
## 🧪 Run unit tests
```sh
npm run test
# check coverage
npm run test:coverage
```
## 🧪 Run E2E tests
```sh
npm run e2e
# headless option
npm run e2e:headless
# ui option
npm run e2e:ui
```
## Use E2E test report
When open Pull Request, you can use an e2e testing report by GitHub Actions.
Set GitHub Pages in your repository.
## ✍️ Authors
- [Davidyang2149](https://github.com/DavidYang2149) - **David Yang** -
See also the list of [contributors](https://github.com/DavidYang2149/react-starter/graphs/contributors)
who participated in this project.
## 📝 License
```
MIT License
Copyright (c) 2022 David Yang
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```