vbrandl/hoc
1
0
Fork 0
Code Issues 1 Pull Requests Actions Projects Releases Wiki Activity
b9878561a7
hoc/README.md
Valentin Brandl b9878561a7
Fix docker badge
2019-04-18 02:00:32 +02:00

1.5 KiB
Raw Blame History

Hits-of-Code

Hits-of-Code Docker build

Small webservice, that returns a badge of the Hits-of-Code of a git repository, as described by Yegor Bugayenko. Currently only GitHub repositories are supported, but it can be trivially extended to support other platforms such as GitLab or Bitbucket.

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

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)