:octocat: A tool that generates a repository which being pushed into your GitHub account creates a nice contributions calendar.
HTML JavaScript CSS
Latest commit e054c89 Oct 11, 2016 @IonicaBizau Updated docs
Permalink
Failed to load latest commit information.
lib update code according to your comments Apr 12, 2016
samples Create happy-2014.json Jan 5, 2014
.dockerignore Add Docker support Mar 5, 2016
.gitignore 📝 Apr 12, 2016
CONTRIBUTING.md Updated docs Apr 26, 2016
DOCUMENTATION.md Updated docs Apr 26, 2016
Dockerfile Add Docker support Mar 5, 2016
LICENSE 🎆 Jan 14, 2016
README.md Updated docs Oct 11, 2016
package.json ⬆️ 3.0.4 🎉 Oct 11, 2016

README.md

gh-contributions

$ gh-contributions

Patreon PayPal AMA Version Downloads Get help on Codementor

A tool that generates a repository which being pushed into your GitHub account creates a nice contributions calendar.

Installation

Global installation

Ensure you configured NPM and NodeJS not to require sudo when installing packages globally.

$ npm i -g gh-contributions

To start the GitHub contributions server, do:

$ gh-contributions

Notes for installing on Windows

For this application to work well on Windows, Git must be installed with the option to put it in PATH enabled, like in this screenshot:

If Git is not installed with this option selected, gh-contributions will not be able to generate the repository.

Local installation

$ git clone git@github.com:IonicaBizau/github-contributions.git
$ cd github-contributions
$ npm i
$ npm start

Usage

The server runs on the 9000 port. Open http://localhost:9000/ in your browser.

Check the help information on the app page (http://localhost:9000), after you start the app.

Running Server Inside Docker Container

You will need to use a version lower than 3.0.0 to run this in Docker. Currently this is not supported anymore.

Build Docker container locally:

docker build -t github-contributions .

Start Docker container:

docker run --rm -it -p 127.0.0.1:9000:9000 --name=github-contributions-server github-contributions

Open http://localhost:9000/ in your browser.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💰 Donations

Another way to support the development of my open-source modules is to set up a recurring donation, via Patreon. 🚀

PayPal donations are appreciated too! Each dollar helps.

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list.

  • auto-contribution (by aleen42)—automatically generate contributions with shell script

📜 License

MIT © Ionică Bizău