ryo-ma/github-profile-trophy
Github Profile Trophy
GitHub Profile Trophy is a service that generates SVG images of achievement trophies based on a GitHub user's profile statistics, designed for embedding in README files. It fetches profile data through the GitHub GraphQL API, renders the trophies server-side as SVG markup, and serves them directly to clients, with a Redis-based caching layer to reduce repeated API calls and speed up subsequent requests.
The service can be deployed as a self-hosted HTTP server running on the Deno JavaScript runtime, packaged with Docker for consistent local and CI environments. It also offers a GitHub Action workflow that generates and commits trophy SVG files directly within a CI pipeline, removing the need for an external hosting service. Configuration is handled through environment variables, controlling server port, visual themes, spacing, and display filters without code changes.
The trophy display is highly customizable, allowing users to adjust the grid layout by setting the number of rows and columns, apply predefined color themes, toggle background transparency and frame visibility, and filter which trophies appear by rank or title. The service supports local SVG generation via a Deno script for offline use, and includes a local development environment with Redis for testing.
Features
- Profile Trophy Renderers - Generates SVG trophy images from GitHub profile statistics for embedding in README files.
- Profile Achievement Visualizations - Converts GitHub profile statistics into a visual trophy display that highlights ranks, titles, and special achievements.
- GitHub API Integrations - Fetches user profile statistics by querying GitHub's GraphQL API with a personal access token.
- Data Visualizations - Fetches GitHub profile statistics via the GraphQL API and renders them as visual trophy SVG badges.
- SVG Server-Side Renderers - Generates trophy images on the server as SVG markup for embedding in README files.
- Badge Generation Servers - Runs a local or CI-based HTTP service that generates and serves customizable trophy SVG images.
- Trophy Rank Filters - Restricts which trophies appear by specifying or excluding titles or ranks to show only relevant achievements.
- Redis Caching Layers - Stores generated trophy data in Redis to reduce repeated API calls and speed up subsequent requests.
- Trophy Title Filters - Shows or hides specific trophy categories by including or excluding their title names from the displayed set.
- Trophy SVG Generators - Provides a GitHub Actions workflow that generates and commits trophy SVG images from profile statistics.
- Trophy SVG Generators - Creates SVG images displaying GitHub achievements and statistics as trophy rows for README profiles.
- SVG Image Servers - Ships a self-hosted HTTP server on Deno that renders customizable trophy SVGs from GitHub API data.
- Trophy Customizations - Adjusts visual appearance of trophy SVGs through themes, spacing, grid layout, and visibility controls.
- Adaptive Grid Counts - Controls the number of rows and columns in the trophy display grid, with an adaptive column option.
- Trophy Grid Layouts - Sets the maximum number of rows and columns to arrange trophies in a grid, with an adaptive column option.
- Profile Statistics Badges - Creates achievement-themed SVG images from GitHub user data for profile pages.
- Developer Tools - Dynamic display of GitHub profile achievements.
- Profile Readme Tools - Generates dynamic GitHub achievement trophies.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
