https://github.com/ionicabizau/github-contributions
:octocat: A tool that generates a repository which being pushed into your GitHub account creates a nice contributions calendar.
https://github.com/ionicabizau/github-contributions
contributions-calendar hacktoberfest mad-science
Last synced: 20 days ago
JSON representation
:octocat: A tool that generates a repository which being pushed into your GitHub account creates a nice contributions calendar.
- Host: GitHub
- URL: https://github.com/ionicabizau/github-contributions
- Owner: IonicaBizau
- License: mit
- Created: 2013-09-17T17:58:22.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-10-02T07:35:25.000Z (over 1 year ago)
- Last Synced: 2024-05-02T06:14:49.643Z (about 1 year ago)
- Topics: contributions-calendar, hacktoberfest, mad-science
- Language: HTML
- Homepage:
- Size: 430 KB
- Stars: 1,333
- Watchers: 25
- Forks: 115
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](#)
# `$ gh-contributions`
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/gh-contributions) [](https://www.npmjs.com/package/gh-contributions) [](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
> 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](https://github.com/IonicaBizau/dotfiles#npm-config).
```js
$ npm i -g gh-contributions
```
To start the GitHub contributions server, do:
```js
$ 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
```js
$ git clone [email protected]: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:
```sh
docker build -t github-contributions .
```
Start Docker container:
```sh
docker run --rm -it -p 127.0.0.1:9000:9000 --name=github-contributions-server github-contributions
```
Open `http://localhost:9000/` in your browser.
## :question: Get Help
There are few ways to get help:
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
## :sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to 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 :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—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! :heart:
## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
- `auto-contribution`
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW