Generate Hits-of-Code badges for GitHub repositories - https://www.yegor256.com/2014/11/14/hits-of-code.html

Go to file

Valentin Brandl 1ec8a76e9c Persist cache		2019-04-20 00:22:19 +02:00
doc	Document the caching mechanism	2019-04-19 22:57:32 +02:00
src	Implement caching	2019-04-19 22:51:58 +02:00
static	Add HTML sections	2019-04-19 19:13:43 +02:00
.dockerignore	Ignore repo directory	2019-04-16 17:04:52 +02:00
.gitignore	Ignore default cache directory	2019-04-19 22:12:57 +02:00
Cargo.lock	Add serde_json to serialize and deserialize the cache	2019-04-19 22:12:41 +02:00
Cargo.toml	Add serde_json to serialize and deserialize the cache	2019-04-19 22:12:41 +02:00
docker-compose.yml	Persist cache	2019-04-20 00:22:19 +02:00
Dockerfile	Copy static resources in docker container	2019-04-16 20:56:24 +02:00
LICENSE	Add license	2019-04-16 20:37:13 +02:00
README.md	Update readme	2019-04-19 16:03:19 +02:00

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

$ 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

TODO

Customization of badges (e.g. colors)
Support other platforms beside GitHub (GitLab and Bitbucket)
Allow exclusion of certain files/globs from the HoC count

License

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