gria - github repository image api

API for fetching public repo summary images for use in GitHub profile READMEs.

Usage

To fetch an image for a public GitHub repository, in your README.md, use this markdown:

![{username}/{repository}](https://gria.smug.af/repo/{username}/{repository})

Here's what that looks like for this repository:

Some examples of other repositories:

This project's dependencies:

Development

This project depends on node-canvas. If you run into issues with an npm install, follow the instructions in their repository: https://github.com/Automattic/node-canvas

Pre-requisites

Several image libraries need to be present in order to build node-canvas with proper support:

brew install pkg-config cairo pango libpng jpeg giflib librsvg

To run the server locally:

npm start

And visit http://localhost:6069/repo/ryan-willis/gria to see the image for this repository.