Add beautiful GitHub contribution/commit graph to your profile README!
GitHub-Contribution-Graph is an awesome tool for dynamically generating contribution graphs that show your GitHub contributions.
It can be used anywhere, you can download the image, share the link, or paste the link in any markdown file, and it will render the image directly on the website.
https://github-contribution-graph.ez4o.com/?username=[YOUR_GITHUB_USERNAME]&last_n_days=[DAYS_YOU_WANT_TO_SHOW]&img_url=[ENCODED_IMAGE_URL]
Parameter | Necessity | Description | Default Value |
---|---|---|---|
username |
Required | Your GitHub username. | None |
last_n_days |
Optional | The n days to show on the chart. 0 < n < 365 | 7 |
img_url |
Optional | Background image. Use url encode tool like https://www.urlencoder.org/. | A Cat Image |
:warning: If you are using large
last_n_days
or large image file: The response time may be very long!
Assume we want:
username = wst24365888
last_n_days = 10
img_url = https://image.cache.storm.mg/media/image/2021/03/05/20210305-031458_U22011_M676060_ca39.gif
Remember to encode it:
https%3A%2F%2Fimage.cache.storm.mg%2Fmedia%2Fimage%2F2021%2F03%2F05%2F20210305-031458_U22011_M676060_ca39.gif
Then, we get:
https://github-contribution-graph.ez4o.com/?username=wst24365888&last_n_days=10&img_url=https%3A%2F%2Fimage.cache.storm.mg%2Fmedia%2Fimage%2F2021%2F03%2F05%2F20210305-031458_U22011_M676060_ca39.gif
And yeah! GitHub-Contribution-Graph actually supports gif!
These are some instructions on setting up your project locally, just follow these simple steps.
Clone the repo.
git clone https://github.com/ez4o/github-contribution-graph.git
cd github-contribution-graph
Install npm packages.
pnpm i
Install Go modules.
go get -u
Fill in the GitHub token inside the configuration.
cp config.json.example config.json
Use release command, and it will generate dist-ssr/
with a executable file
inside.
make release-windows
or
make release-linux
Get dist-ssr/
, and you can deploy it anywhere!
When execute, GitHub-Contribution-Graph will use port 8686 and 8687.
last_n_days
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
git checkout -b feat/amazing-feature
)git push origin feat/amazing-feature
)Distributed under the MIT License. See LICENSE for more information.