RepoStats

This utility, written in Golang and TDD with acceptance tests, can fetch data on a sample of 100 repositories.

Installation

You can first clone the project in your desired folder :

git clone https://github.com/bachrc/repo-stats # Clone the repository
cd repo-stats # Go inside the freshly created

This project needs your Go version to be 1.17+.

You can clone the repository :

<parameters> go run github.com/bachrc/repo-stats/cmd/web # And then you launch the web server

In the docker-compose.yml file, you'll need to fill the required parameters specified below.

When done, you can launch the application :

docker-compose up -d

To make the application run smoothly, you'll need to provide some environment variables :

GITHUBACCESSTOKEN : This parameter is required. Because of Github public API rate limits, you'll need to generate a token with your Github account.
PORT : The port on which the webserver will run.

The API description is available as an OpenAPI file.

The description of the architecture is available in the ARCHITECTURE.md file.

A little more context about the realisation of this exercise can be found (in French) in the CONTEXTE-EXERCICE.md file.