Explore Usage »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Usage
   • Parameters
3. Deploy Your Own Server
4. Roadmap
5. Contributing
6. License
7. Acknowledgments
8. Contact

About The Project

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.

(back to top)

Getting Started

Usage

https://github-contribution-graph.ez4o.com/?username=[YOUR_GITHUB_USERNAME]&last_n_days=[DAYS_YOU_WANT_TO_SHOW]&img_url=[ENCODED_IMAGE_URL]

Parameters

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

⚠️ If you are using large last_n_days or large image file: The response time may be very long!

Example

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!

(back to top)

Deploy Your Own Server

These are some instructions on setting up your project locally, just follow these simple steps.

Prerequisites

• GNU Make

• Go

• pnpm

• ffmpeg

• gifsicle

Installation

1. Clone the repo.

   git clone https://github.com/ez4o/github-contribution-graph.git
   cd github-contribution-graph

2. Install npm packages.

   pnpm i

3. Install Go modules.

   go get -u

4. Fill in the GitHub token inside the configuration.

   cp config.json.example config.json

Generate Dist-SSR

1. Use release command, and it will generate dist-ssr/ with a executable file inside.

   make release-windows

   or

   make release-linux

2. Get dist-ssr/, and you can deploy it anywhere!

When execute, GitHub-Contribution-Graph will use port 8686 and 8687.

(back to top)

Roadmap

• Customize Background Image
• CSS Animation (actually, it's a SMIL animation lol)
• New Parameter: last_n_days
• More Patameters...

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/amazing-feature)
3. Commit your Changes with Conventional Commits
4. Push to the Branch (git push origin feat/amazing-feature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

• Design Inspiration
• Background Image Used in Examples

(back to top)

Contact

Author

• HSING-HAN, WU (Xyphuz)
  • Mail me: xyphuzwu@gmail.com
  • About me: https://about.xyphuz.com
  • GitHub: https://github.com/wst24365888

Project Link

• https://github.com/ez4o/github-contribution-graph

(back to top)