Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged! 
This guide serves to set clear expectations for everyone involved with the project so that we can improve it together while also creating a welcoming space for everyone to participate. Following these guidelines will help ensure a positive experience for contributors and maintainers.
Before you start contributing you must clone and installing this project on your local machine.
Prerequisite: you must install rust v1.56+ and node v20+ on your machine first
- Clone the project
# using ssh
git clone [email protected]:oxwazz/github_contributions_widget.git
# or using https
git clone https://github.com/oxwazz/github_contributions_widget.git- Create GitHub token &
paste on
wrangler.toml
[vars]
GITHUB_TOKEN = "" # <- replace this empty string with yout GitHub token- Open and run
# opening project
cd github_contributions_widget
# run
npx wrangler devdone 🎉
This code is deployed on Cloudflare worker. The main entry script is lib.rs. It makes a request to the GitHub API, and create svg based on the responses.
While working this project I'm usually using this tools, like:
- https://yqnn.github.io/svg-path-editor - create svg path
- https://cloudconvert.com/ttf-to-woff2 - convert font .ttf format to .woff2
- https://www.giftofspeed.com/base64-encoder - convert font .woff2 format to base64
- https://inkscape.org/release - create wireframe