DEV Community

Cover image for GitHub PR Stats - Visualization Tool for Creating Beautiful SVG Cards
f14XuanLv
f14XuanLv

Posted on

GitHub PR Stats - Visualization Tool for Creating Beautiful SVG Cards

GitHub PR Stats - Visualization Tool for Creating Beautiful SVG Cards

Create beautiful SVG cards for your resume and profile by visualizing your GitHub PR statistics.

Repository

GitHub Repository: https://github.com/f14XuanLv/github-pr-stats

What is this tool?

This tool automatically generates beautiful statistical cards from your open source code contributions. The tool helps you:

  • Track contributions: Display which projects you've participated in and how many contributions you've made
  • Show merge statistics: See how many PRs were merged and calculate your merge rate
  • Generate visual cards: Create embeddable SVG cards through a user-friendly frontend interface
  • Multiple platform support: Use the generated SVG URLs across various platforms

Why use this tool?

  • Resume enhancement: Use concrete data to demonstrate your technical skills
  • Professional credibility: Show your ability to contribute to large-scale open source projects
  • Portfolio building: Create a clear visual representation of your contribution history
  • Motivation tracking: Visualize your progress to stay motivated in open source contributions

Visual Examples

PR List Mode (Dark Theme)

This mode displays one record per pull request, showing detailed information about each contribution.

GitHub PR Stats Dark Theme

Markdown embed code:

![GitHub PR Stats](https://github-pr-stats-five.vercel.app/api/github-pr-stats?username=f14xuanlv&theme=dark&status=all&min_stars=8&limit=10&sort=status%2Cstars_desc&stats=all&fields=repo%2Cstars%2Cpr_title%2Cpr_number%2Cstatus%2Ccreated_date%2Cmerged_date&mode=pr-list)
Enter fullscreen mode Exit fullscreen mode

Repository Aggregate Mode (Light Theme)

This mode groups contributions by repository, showing summary statistics for each project.

GitHub PR Stats Repository Aggregate

Markdown embed code:

![GitHub PR Stats Repository Aggregate](https://github-pr-stats-five.vercel.app/api/github-pr-stats?username=f14xuanlv&theme=light&status=all&min_stars=8&limit=10&sort=status%2Cstars_desc&stats=all&fields=repo%2Cstars%2Ctotal_prs%2Cmerged_prs%2Cmerge_rate&mode=repo-aggregate)
Enter fullscreen mode Exit fullscreen mode

Getting Started

Interactive Configuration Interface

Use the web-based configuration tool to customize your stats card:

Launch Configuration Tool

The frontend interface provides:

  • Username input field for your GitHub account
  • Theme selection (light and dark modes)
  • Parameter configuration options
  • Real-time preview of your stats card
  • Generated embed URLs for easy copying

Deploy Your Own Instance

Deploy this tool to your own Vercel account with one click:

Deploy with Vercel

Important Setup Information
You'll need to configure environment variables after deployment. Please refer to the project README for detailed setup instructions including:
  • GitHub token configuration
  • API rate limiting settings
  • Cache configuration options

Key Features

Display Modes:

  • PR List Mode: Shows individual pull request records with detailed information
  • Repository Aggregate Mode: Groups contributions by repository with summary statistics

Customization Options:

  • Theme Support: Choose between light and dark themes for better readability
  • Flexible Filtering: Filter contributions by star count, PR status, and date ranges
  • Customizable Fields: Select which information to display on your stats card
  • SVG Output: Generate high-quality, scalable vector graphics
  • Real-time Preview: See changes instantly while configuring your card

Integration Features:

  • Easy Embedding: Simple markdown code for GitHub profiles and websites
  • Multiple Platform Support: Works across various platforms that support SVG images
  • URL Generation: Automatic generation of embeddable URLs

Use Cases

Professional Development:

  • GitHub Profile README: Enhance your GitHub profile with visual contribution statistics
  • Technical Resume: Add concrete visual evidence of your coding contributions
  • Portfolio Websites: Display your open source involvement prominently

Community Engagement:

  • Project Documentation: Show your participation in various open source projects
  • Developer Networking: Use as a conversation starter about your contributions
  • Personal Branding: Build credibility as an active open source contributor

Support This Project

If this tool helps showcase your contributions effectively, please consider giving it a star on GitHub to support continued development.

⭐ Star the project on GitHub ⭐


Want to contribute?


The project welcomes contributions including:

  • Bug fixes and improvements
  • New theme designs
  • Additional display modes
  • Documentation improvements
  • Feature suggestions and feedback

Top comments (0)