CatWatch provides a web application that fetches regularly statistics for your GitHub accounts from GitHub. The web application processes and saves the data in a database and then makes the data available via a REST-API. The provided data reveal the popularity of your projects, your most active contributors etc.
In comparison to CoderStats the statistics can be aggregated over a list of GitHub accounts.
- maven
- java 8
- postresql
First run postgresql and create the database and a role via unix shell
postgres -D /usr/local/var/postgres
createdb catwatch
createuser cat1
Build and run the web application either by Gradle or Maven.
Gradle:
cd catwatch-backend
# build
./gradlew build
# run
java -jar build/libs/catwatch-backend-0.0.1-SNAPSHOT.jar -Dorganization.list=<listOfGitHubAccounts>
Maven:
cd catwatch-backend
# build (Note: currently postresql with database and role is needed! TODO: Tests need H2 database running)
mvn package
# run
mvn spring-boot:run -Dorganization.list=<listOfGitHubAccounts>
# run with postgresql and auto create the database
mvn spring-boot:run -Dspring.profiles.active=postgresql -Dspring.jpa.hibernate.ddl-auto=create
# run with H2 in memory database and auto create the database
mvn spring-boot:run -Dspring.profiles.active=hbm2ddl -Dspring.jpa.hibernate.ddl-auto=create
The web application is available under http://localhost:8080
It provides the CatWatch REST-API.
By default the web application uses an H2 in-memory database. The file application-postgresql.properties demonstrates how a PostgreSQL database can be configured. %