/github-basic-badges

Basic badges for github

Primary LanguageRubyMIT LicenseMIT

GitHub Basic Badges

GitHub Release GitHub Download Count GitHub Issues Open

Basic badges for using with GitHub, and a service that you can deploy and create your own service to serve the GitHub badges.

Motivation

I know there are alots of services that you can generate badges for GitHub, i just developed one more to play around with Ruby and Heroku.

Badges

All the URL Patterns showed in the table bellow must be used as <app-url>\<url-pattern>.

URL Pattern Description Preview
downloads/<user>/<repo>/total.svg Sum of downloads of all artifacts in the latest release. GitHub Download Count
downloads/<user>/<repo>/<tag>/total.svg Sum of downloads of all artifacts in the release with the <tag> GitHub Download Count By Tag
downloads/<user>/<repo>/<file>.svg Total downloads of the artifact named <file> in the latest release. GitHub Download Count By Artifact
downloads/<user>/<repo>/<tag>/<file>.svg Total downloads of an artifact named <file> in the release with a tag name <tag>. GitHub Download Count By Artifact and Release
release/<user>/<repo>.svg Latest release tag name. GitHub Release
issues/<user>/<repo>.svg Total issues open. GitHub Issues Open
commits/<user>/<repo>.svg Total commits. GitHub Commits
license/<user>/<repo>.svg Project LICENSE. GitHub License
pulls/<user>/<repo>.svg Project open pull requests. GitHub Pull Requests

Custom colors and text

You can customize the colors and the text of the badges, just use color and text parameters in the url, like customizing the last release example, check below:

GitHub Release Ex 1 GitHub Release Ex 2 GitHub Release Ex 3 GitHub Release Ex 4 GitHub Release Ex 5 GitHub Release Ex 6

For colors you can use any hex colors you want, and some basic already defined, check the file badge.rb for some basic colors.

Deploying on Heroku

Install heroku toolbet and log to it after that, it's pretty straigth forward deploying on heroku, just do the following:

# Cloning the repository
git clone https://github.com/kennedyoliveira/github-basic-badges.git
cd github-basic-badges

# Create a heroku app
heroku create

# Push the code to heroku
git push heroku master

# Open the app
heroku open

Mine Heroku App

My instance is running in the following url https://github-basic-badges.herokuapp.com you can use it to generate badges for your repos!

If you have any question or suggestion, open an issue!