tolgaek / github-contributions

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

GitHub 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.

brew --prefix

brew --prefix

brew `--`prefix

$ npm install -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 install
$ npm start

Usage

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

Design your calendar

Click the day elements you want to have contributions. They will become green. If you want to activate smooth drawing, press Shift and hover the day elements. To clear them, click them again or activate clearing with hovering, holding the Ctrl key.

If you want to insert a text, that's even easier: insert your text in the textbox above, and click the Generate data from text button. Then to preview the generating JSON click the Toggle calendar days from data button.

pro tip: Modify the commitsPerDay value (default is 10) to a greater value if you want to have more contributions per day.

Generating the repository

Once you are ready and happy with the graph calendar you designed, press the Generate data from calendar button and then Generate repository from data.

Pushing the repository on GitHub

Once the repository is generated, download the zip archive clicking the download link.

1. Unzip the archive
2. Create an empty repository on GitHub.
3. Add the remote to your downloaded and unzipped repository.
4. Do git push --all
5. Enjoy!

Delete the graph calendar

If you want or need to delete the graph calendar, simply delete the repository.

1. Go to the settings page of your repository.
2. Click Delete this repository.
3. Confirm the name of the repository.

Update the graph calendar

To add new things on the contributions calendar, simply create new repositories which will create graphs to overlap the others.

How to contribute

1. File an issue in the repository, using the bug tracker, describing the contribution you'd like to make. This will help us to get you started on the right foot.
2. Fork the project in your account and create a new branch: your-great-feature.
3. Commit your changes in that branch.
4. Open a pull request, and reference the initial issue in the pull request message.

License

See the LICENSE file.