SSR-Contribution-Svg

A Nest.js API to render GitHub user's contributions to chart

Just pass Github username in route params, you will get the contribution wall render by svg. Support custom output format, color, quantity, size and so on

online example

Usage

• prepare your github pat for Github OpenAPI:

  https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

• create a .env file in the root of project, Fill it with reference .env.example

• install packages with:

  # npm install
  yarn install

• run server:

  # npm run start:dev
  yarn start:dev

• try it out visit http://localhost:${port}/_/${username},

  • port: SERVE_PORT variable in your .env, default is 3000
  • username: Github username

Configuration

Example

• pin to notion

• Use as ios widget with Scritable, example code:

    let url = "https://ssr-contributions-svg.vercel.app/_/CatsJuice?format=png&quality=2&theme=red&widget_size=midium"
  
    let w = await createWidget();
    Script.setWidget(w);
  
    async function createWidget() {
      let w = new ListWidget();
      let random = (Math.random()*100000000).toFixed(0);
      let data = await new Request(url + "&random=" + random).load();
      let image = Image.fromData(data);
      w.backgroundImage = image;
      return w;
    }

  Add scritable widget to home screen, and select script in widget configuration.