commitInfo

A small microservice to pull the latest number of commits from the GitHub API for a specific user.

Designed to work as a custom endpoint for Shields.io.

$ curl http://127.0.0.1:8000/
{"schemaVersion":1,"label":"codemicro's total commits","message":"1578","colour":"green"}

Clone this repository and build the Docker image

git clone https://github.com/codemicro/githubCommitInfo.git
cd githubCommitInfo
docker build -t commitinfo .

Start the Docker container

docker run -d --restart unless-stopped -p 8000:80 -e GITHUB_OAUTH_TOKEN="your personal access token" -e GITHUB_USERNAME="codemicro" commitinfo

This will start the server on port 8000 of your local machine for the user codemicro.

This should run on any platform that can run Go 1.14 or later.

Clone this repository

git clone https://github.com/codemicro/githubCommitInfo.git
cd githubCommitInfo

Build using Go

go build github.com/codemicro/githubCommitInfo/cmd/githubCommitInfo
sudo chmod +x githubCommitInfo

Run

GITHUB_OAUTH_TOKEN="your personal access token"
GITHUB_USERNAME="codemicro"
./githubCommitInfo

This will start the server on port 80 for the user codemicro.

To reverse proxy this using the Apache2 HTTP server:

<Location /a/path>
    ProxyPass http://127.0.0.1:8000/
    ProxyPassReverse http://127.0.0.1:8000/
</Location>

This service is designed to work as a JSON endpoint that can be used with Shields.io. Read more here.