CatWatch is a web application that fetches GitHub statistics for your GitHub accounts, processes and saves your GitHub data in a database, then makes the data available via a REST API. The data reveals the popularity of your open source projects, most active contributors, and other interesting points. As an example, you can see the data at work behind the Zalando Open Source page.
To compare it to CoderStats: CatWatch aggregates your statistics over a list of GitHub accounts.
- Maven 3.0.5
- Java 8
- PostgreSQL 9.4
First, run PostgreSQL and create the database and a role via a unix shell:
psql -c "create database catwatch;" -U postgres -h localhost psql -c "create database catwatch_test;" -U postgres -h localhost psql -c "create user cat1 with password 'cat1';" -U postgres -h localhost
Build and run the web application with Maven.
cd catwatch-backend # build ../mvnw package # run ../mvnw spring-boot:run -Dorganization.list=<listOfGitHubAccounts> # run with postgresql and auto create the database (drops existing contents) ../mvnw spring-boot:run -Dspring.profiles.active=postgresql -Dspring.jpa.hibernate.ddl-auto=create # run with H2 in memory database and auto create the database ../mvnw spring-boot:run # run with GitHub basic authentication ../mvnw spring-boot:run -Dgithub.login=XXX -Dgithub.password=YYY # run with GitHub OAuth token (supports 2FA) ../mvnw spring-boot:run -Dgithub.oauth.token=XXX
The web application is available at http://localhost:8080
It provides the CatWatch REST API.
Travis CI is used for continuous integration (see button on the top). Coveralls is used for tracking test coverage (see button on the top).
By default, the web application uses an H2 in-memory database. The file application-postgresql.properties demonstrates how a PostgreSQL database can be configured.
After the application is started, some test data are added to the database.
Currently the scheduler is being executed at 8:00 AM every morning. There are some endpoints.
Initialise the database with test data (for the virtual organization 'galanto''):
Drop the database:
Import the data (see catwatch-dump/export.txt):
Export the data:
Fetch the data. Please note that the properties
github.password must be set:
Get the config:
Update temporarily the scoring function for projects (see catwatch-score/scoring.project.sh):
Here are open tasks regarding the infrastructure:
- Deployment (Database migration, GitHub account credentials management)
- Robustness (DB fails, CatWatch backend fails)
- Cleaning up the code base
Potential and confirmed bugs:
- not all Zalando projects are listed (confirmed)
- the number of contributors is not correct (potential)
- the time series graphs should be hidden for the first version as they break the responsive layout (confirmed)