hoc/README.md

Hits-of-Code

Small webservice, that returns a badge of the Hits-of-Code of a git repository, as described by Yegor Bugayenko. It is implemented in Rust, using the actix-web web framework.

A live version of this API can be found on hitsofcode.com.

API

The API is as simple as

https://<host>/<service>/<user>/<repo>

where <service> is one of gitub, gitlab or bitbucket.

Building

The code can be built as a standalone binary, using cargo or as a Docker container. Run either

$ cargo build --release

or

$ docker build .

inside the repository.

Running

Run either the binary produced by cargo, the Docker container you just built (using docker-compose) or pull the image from Docker Hub

$ docker run -it --rm vbrandl/hits-of-code --help

License

hoc is licensed under the MIT License (LICENSE or http://opensource.org/licenses/MIT)