https://app.swaggerhub.com/apis/kgruszowski/github-comparator/1.0.0
- assuming you have installed PHP > 7.0 and composer installed globally
- enter main directory and run composer install
- run bin/console server:run 127.0.0.1:8001
- app will be accessible via 127.0.0.7:8001
The application is written with help of Symfony 3 Framework and FOSRestBundle due to REST support. I've decided to use php-github-api to access Github Api, but wrap it with my own abstraction, to adding new Version Control System API's in future. As far as good practice concerned I use PHPUnit to write Unit Tests, PHP Messdetector to ensure code quality and Travis-CI to support Continuous Integration process.
At the beginning I've planned use User and Repository model to compare two repositories. User model to compare reliability of repo owner and Repository model to compare basic stats like number of stars, watchers, last commit date etc. Unfortunately due to time shortage, I've implemented only Repository metrics comparison. I've also planned to use Behat as a framework to write functional tests, but I've focused only on unit tests of key components.
- number of stars (more is better)
- number of watchers (more is better)
- number of forks (the more is better)
- number of open issues (less is better)
- last update/commit date (more recent is better)
- created date (always a draw)
Next steps that could be considered to develop app
- dockerize application
- use cache (e.g. Redis) to lower network overhead in Github API calls
- add functional tests using e.g. Behat
- add automated API documentation
- add User model to comparison