A monitoring tool that allows you to quickly view all Github pull requests of your teams and their statuses.
View the demo site for a real example.
$ git clone https://github.com/M6Web/GithubTeamReviewer.git
$ cd GithubTeamReviewer
$ npm install -g bower gulp
$ npm install
$ bower install
Please configure a new config/config.json
file from config/config.json.dist
.
Options :
- refreshInterval : time between 2 dashboard updates (be careful with low interval because you can reach API rate limit quickly),
- teams : list of teams, keys are teams names and you can define these properties for each :
- members : an array of Github usernames,
- org : an array of Github organizations,
- apiUrl : url of your Github API (optional, default is
https://api.github.com
), - token : authorization token for API calls (optional, it can increase API rate limit).
After configuration, you have to build the code and launch the server.
$ gulp serve:dist
For development, you can launch the server on the unbuilt code.
$ gulp serve
It will automatically open the dashboard in your browser.
Use directly the page path in order to select a team.
http://gtr-url/index.html#/myTeam
Colors show the PR statuses :
- black when there is no test
- yellow when the tests are running
- red when tests fail
- green when tests are successful
Test the unbuilt code :
$ gulp test
Test the build :
$ gulp test:dist
Developed by the Cytron Team of M6 Web.
Github Team Reviewer is licensed under the MIT license.