GitHub-Contribution-Graph

An awesome tool for dynamically generated contribution graphs that show your GitHub contributions for the last 7 days!

Explore Usage »

Report Bug
·
Request Feature

Table of Contents
  1. About The Project
  2. Getting Started

  3. Roadmap
  4. Contributing
  5. License
  6. Acknowledgments
  7. Contact

About The Project

screenshot

GitHub-Contribution-Graph is an awesome tool for dynamically generated
contribution graphs that show your GitHub contributions for the last 7 days.

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]&img_url=[ENCODED_IMAGE_URL]

Example

https://github-contribution-graph.ez4o.com/?username=wst24365888&img_url=https%3A%2F%2Fimages.unsplash.com%2Fphoto-1506744038136-46273834b3fb%3Fixid%3DMnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8%26ixlib%3Drb-1.2.1%26auto%3Dformat%26fit%3Dcrop%26w%3D1000%26q%3D80

Parameters

Parameter Necessity Description
username Required Your GitHub username.
img_url Optional Background image. Use url encode tool like https://www.urlencoder.org/.

(back to top)

Deploy Your Own Server

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

Prerequisites

Installation

  1. Clone the repo.

    git clone https://github.com/ez4o/github-contribution-graph.git
    cd github-contribution-graph
  2. Install npm packages.

    npm i
  3. Install Go packages.

    go get -u

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

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

(back to top)

Contact

HSING-HAN, WU (Xyphuz) – [email protected]

Project Link: https://github.com/ez4o/github-contribution-graph

(back to top)

GitHub

View Github