rx007 / github-contributions

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

$ gh-contributions

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 [e-mail]: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.

💖 Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like 🚀

• —I love books! I will remember you after years if you buy me one. 😁 📖

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

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