React Starter

• GitHub: React starter kit
• npm: Download

🚀 Quick start

npx @davidyang2149/react-starter <project-directory>

💎 Tech stack

• TypeScript
• ESLint
• Vite
• React
• Jest
• Testing-Library
• Cypress

📚 Install dependencies

npm install

💻 Run dev server

npm run start

🧪 TypeScript check

npm run check

🧪 ESLint check

npm run lint

🧪 Run unit tests

npm run test

# check coverage
npm run test:coverage

🧪 Run E2E tests

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 - David Yang - [email protected]

See also the list of 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.