Table of Contents
About The Project
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.
||Required||Your GitHub username.|
||Optional||Background image. Use url encode tool like https://www.urlencoder.org/.|
Deploy Your Own Server
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.
Install Go packages.
go get -u
Use release command, and it will generate
dist-ssr/with a executable file inside.
dist-ssr/, and you can deploy it anywhere!
When execute, GitHub-Contribution-Graph will use port 8686 and 8687.
- Customize Background Image
- CSS Animation
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feat/amazing-feature)
- Commit your Changes with Conventional Commits
- Push to the Branch (
git push origin feat/amazing-feature)
- Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
HSING-HAN, WU (Xyphuz) - [email protected]
Project Link: https://github.com/ez4o/github-contribution-graph