kena0ki/github-profile-card

Web API serves profile card image for GitHub in SVG format

github-profile-card

Note: This repository is kind of like user profile version of gh-card.
This is source code repository for web API which serves github profile card.
The web API creates cards on each request, currently with no cache, so cards displayed on the client is always up to date.

Usage

Endpoint

https://gpc.znoo.xyz/api/github/:username

Query parameters

Currently, following parameters are available.

• width: width of the card
• height: height of the card

Sample

The sample page is here.
All you need is a normal URL, so this can also be used for Markdown, like the image in the Author section.

Development

• Gitpod: Click the above Gitpod badge
• Vim: Run make dev or docker-compose run --rm --service-ports api bash
• VS Code: Open this repository by VS Code (Remote Development Extension is needed)

This repository is inspired by

• gh-card
• GitHub Link Card Creator
• Unofficial GitHub Cards

Author

License

MIT