👋️ Create React App Codely template example
App created with the 🌱⚛️ Create React App Codely template
Stars are welcome 😊
🚀 Run the app
yarn install: Install dependenciescp .env.example .env: Create the environment variables file based on the example templatevim .env: Specify your GitHub Personal access token (how to get it -> your tokens -> EnableRepo.public_repo)vim src/devdash_config.ts: Set the repository URLs you want to show on your DevDash_yarn start: Run in dev mode on localhost:3000yarn build: Generate production build
✅ Testing
Unit tests
yarn test: Run unit tests with Jest and React Testing Library
End-to-end tests
yarn start: Run in dev mode on localhost:3000- Run end-to-end tests with Cypress choosing one of the following options:
yarn cy:open: Open Cypress in dev modeyarn cy:run: Execute Cypress in CLI
🔦 Linting
yarn lint: Run linteryarn lint:fix: Fix lint issues
🌈 Tech Stack
- TypeScript
- ESLint and Prettier already configured with the 🤏 Codely's configuration
- Jest with React Testing Library for the unit tests
- Cypress with Testing Library for the end-to-end tests
- GitHub Action Workflows set up to run tests and linting on push
- Makefile for standardize how to run projects
- Sass to supercharge CSS with nested classes and more fun
- .editorconfig for sharing the IDE config
👌 Codely Code Quality Standards
Publishing this package we are committing ourselves to the following code quality standards:
- 🤝 Respect Semantic Versioning: No breaking changes in patch or minor versions
- 🤏 No surprises in transitive dependencies: Use the bare minimum dependencies needed to meet the purpose
- 🎯 One specific purpose to meet without having to carry a bunch of unnecessary other utilities
- ✅ Tests as documentation and usage examples
- 📖 Well documented ReadMe showing how to install and use
- ⚖️ License favoring Open Source and collaboration
🔀 Related information
This application was generated using the 🌱⚛️ Create React App Codely template. Feel free to check it out and star the repo! 🌟😊🙌