Developer dashboard focused on learning React appling best practices.
App created with the 🌱⚛️ Create React App Codely template
Stars are welcome 😊
npm 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_npm start
: Run in dev mode on localhost:3000npm run build
: Generate production build
npm run test
: Run unit tests with Jest and React Testing Library
npm start
: Run in dev mode on localhost:3000- Run end-to-end tests with Cypress choosing one of the following options:
npm run cy:open
: Open Cypress in dev modenpm run cy:run
: Execute Cypress in CLI
npm run lint
: Run linternpm run lint:fix
: Fix lint issues
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
This application was generated using the 🌱⚛️ Create React App Codely template. Feel free to check it out and star the repo! 🌟😊🙌