https://github.com/kena0ki/github-profile-card
Web API serves profile card image for GitHub in SVG format
https://github.com/kena0ki/github-profile-card
card github markdown ogp profile svg
Last synced: 7 months ago
JSON representation
Web API serves profile card image for GitHub in SVG format
- Host: GitHub
- URL: https://github.com/kena0ki/github-profile-card
- Owner: kena0ki
- License: mit
- Created: 2020-01-26T15:01:56.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-03T11:18:37.000Z (over 4 years ago)
- Last Synced: 2025-03-23T08:42:28.022Z (11 months ago)
- Topics: card, github, markdown, ogp, profile, svg
- Language: Go
- Homepage: https://gpc.znoo.xyz/
- Size: 108 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-profile-card
[](https://gitpod.io/#https://github.com/kena0ki/github-profile-card)
Note: This repository is kind of like user profile version of [gh-card](https://github.com/nwtgck/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](https://gpc.znoo.xyz/).
All you need is a normal URL, so this can also be used for Markdown, like the image in [the Author section](#Author).
## 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](https://github.com/nwtgck/gh-card)
* [GitHub Link Card Creator](https://github.com/po3rin/github_link_creator)
* [Unofficial GitHub Cards](https://github.com/lepture/github-cards)
## Author
[](https://github.com/kena0ki)
## License
MIT