Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (44 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

63 lines (44 loc) · 2.02 KB

Contributing Guidelines

Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged! :octocat:

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.

Contents

📚 Install

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

  1. Clone the project
# using ssh
git clone git@github.com:oxwazz/github_contributions_widget.git
# or using https
git clone https://github.com/oxwazz/github_contributions_widget.git
  1. Create GitHub token & paste on wrangler.toml
[vars]
GITHUB_TOKEN = "" # <- replace this empty string with yout GitHub token
  1. Open and run
# opening project
cd github_contributions_widget
# run
npx wrangler dev

done 🎉

🧵 How it works

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.

🔧 Tools

While working this project I'm usually using this tools, like:

  1. https://yqnn.github.io/svg-path-editor - create svg path
  2. https://cloudconvert.com/ttf-to-woff2 - convert font .ttf format to .woff2
  3. https://www.giftofspeed.com/base64-encoder - convert font .woff2 format to base64
  4. https://inkscape.org/release - create wireframe