Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sallar/github-contributions-chart
:octocat: Generate an image of all your Github contributions
https://github.com/sallar/github-contributions-chart
contributions contributions-chart github octocat
Last synced: 21 days ago
JSON representation
:octocat: Generate an image of all your Github contributions
- Host: GitHub
- URL: https://github.com/sallar/github-contributions-chart
- Owner: sallar
- License: mit
- Created: 2018-04-29T15:32:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-15T23:08:20.000Z (4 months ago)
- Last Synced: 2024-10-01T20:04:43.565Z (about 1 month ago)
- Topics: contributions, contributions-chart, github, octocat
- Language: JavaScript
- Homepage: https://github-contributions.vercel.app
- Size: 3.32 MB
- Stars: 5,223
- Watchers: 25
- Forks: 239
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome - sallar/github-contributions-chart - :octocat: Generate an image of all your Github contributions (JavaScript)
- awesome - github-contributions-chart - :octocat: Generate an image of all your Github contributions (JavaScript)
- awesome - sallar/github-contributions-chart - :octocat: Generate an image of all your Github contributions (JavaScript)
- awesome-readme-tools - GitHub Contributions Chart - :octocat: Generate an image of all your Github contributions (Statistical Tools (Widgets))
- awesome-list - github-contributions-chart
- awesome-github-profile - GitHub Contribution Chart Generator
README
# :octocat: GitHub Contribution Chart Generator [](https://github.com/sallar/github-contributions-canvas/blob/master/LICENSE)
Generates an image of all your **GitHub** contributions since you have signed up, so you can use it in social media.
The API for this project lives in the `src/pages/api` directory since GitHub doesn't provide a way to access user statistics through it's official API.
The drawing mechanism lives in [the sallar/github-contributions-canvas repository](https://github.com/sallar/github-contributions-canvas).
## Requirements
- A valid github account.
- Open activity in setting (`Settings` > `Public profile` > `Contributions & Activity`).
- [ ] Make profile private and hide activity
## Install
Install the packages using [NPM](https://nodejs.org/en/):
```
$ npm install
```
## How to run
Running locally:
```
$ npm run dev
```
## Deployment
This project is deployed on [Vercel](https://vercel.com/).
## Adding themes
Add your theme to [sallar/github-contribution-canvas](https://github.com/sallar/github-contributions-canvas) repo and also send a PR here to add the name of the theme to the list.
## Example
## Contributing
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Changelog
Every release, along with the migration instructions, is documented on the GitHub [Releases](https://github.com/sallar/github-contributions-chart/releases) page.
## License
[MIT license](https://opensource.org/licenses/MIT)
[](https://vercel.com/?utm_source=github-contributions-chart&utm_campaign=oss)