Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mlbonniec/ailurio

Dynamically generate images cover for your Github repository, issues, pull requests or commits.
https://github.com/mlbonniec/ailurio

canvas fastify fastifyjs github-api image-generation node-canvas nodejs statistics

Last synced: about 1 month ago
JSON representation

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

Host: GitHub
URL: https://github.com/mlbonniec/ailurio
Owner: mlbonniec
Created: 2021-04-16T17:10:07.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-03-29T16:08:52.000Z (9 months ago)
Last Synced: 2024-03-30T16:51:17.015Z (9 months ago)
Topics: canvas, fastify, fastifyjs, github-api, image-generation, node-canvas, nodejs, statistics
Language: TypeScript
Homepage: https://github.com/mlbonniec/ailurio
Size: 2.81 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # 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](#ailurio)

	- [Table of Contents](#table-of-contents)

	- [Preview](#preview)

	- [Functioning](#functioning)

	- [To-do](#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.

[![OnBoardingKit](./docs/demo.png)](https://github.com/mlbonniec/OnBoardingKit)

## Functioning

Ailurio is a web server, running with [`Fastify`](https://www.fastify.io/), which serves images, generated by [`node-canvas`](https://github.com/Automattic/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`](https://octokit.github.io/rest.js/).

## To-do

- [ ] Catch errors

  - [x] 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

- [x] Fix too long descriptions

- [ ] Fix build script