README.md

Ailurio

Dynamically generate images cover for your GitHub repository, issues, pull requests or commits.

The design and functionality are inspired by a new GitHub feature, which dynamically modifies og:image of GitHub repository pages.

Table of Contents

• Ailurio
  • Table of Contents
  • Preview
  • Functioning
  • To-do

Preview

When you make a GET request at /mlbonniec/OnBoardingKit, you'll get an image like this one. Displaying your repository statistics.
You can create images for any GitHub repository.

Functioning

Ailurio is a web server, running with Fastify, which serves images, generated by node-canvas which allows to use HTML canvas from NodeJS.
The data is retrieved from the GitHub API, using the official GitHub client for NodeJS, @octokit/rest.js.

To-do

• Catch errors
  • Unexisting owner or repository
  • Rate limit
• Display contributors (currently disabled due to GitHub pagination system).
• Support issues
• Support commits
• Support pull requests
• Add caching system
• Fix too long descriptions
• Fix build script