Skip to content

encryptedtouhid/github_readme_stats

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
.github
.github
 
 
src
src
 
 
.gitattributes
.gitattributes
 
 
.gitignore
.gitignore
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
README.md
README.md
 
 

Repository files navigation

GitHub Readme Stats

A .NET 9 Web API that generates customizable SVG cards displaying GitHub user and repository statistics for embedding in README files.

Features

  • Streak Stats Card - Current streak, longest streak, and total contributions with animated SVG
  • User Stats Card - Stars, commits, PRs, reviews, followers, and rank
  • Top Languages Card - Most used programming languages
  • Repository Card - Pinned repository information
  • Gist Card - Gist statistics

Prerequisites

  • .NET 9.0 SDK
  • Redis (optional, for distributed caching)

Getting Started

# Build
cd src
dotnet build GitHubStats.sln

# Run
cd GitHubStats.Api
dotnet run

The API will be available at http://localhost:5042.

API Endpoints

Endpoint Description
/api/streak?username={user} Streak statistics card
/api/stats?username={user} User statistics card
/api/top-langs?username={user} Top languages card
/api/pin?username={user}&repo={repo} Repository pin card
/api/gist?id={gist_id} Gist card
/health Health check

Usage

Add to your GitHub README:

![GitHub Streak](https://github-readme-stats.tuhidulhossain.com/api/streak?username=encryptedtouhid)

Streak Card Options

Parameter Description Default
username GitHub username (required) -
theme Card theme default
hide_border Hide card border false
border_radius Card corner radius 4.5

Themes

Use the theme parameter to customize your card:

![GitHub Streak](https://github-readme-stats.tuhidulhossain.com/api/streak?username=encryptedtouhid&theme=tokyonight)

Theme Examples

Theme Preview
github_light github_light
github_dark github_dark
tokyonight tokyonight
dracula dracula
nord nord
radical radical
sunset_dark sunset_dark
ocean_deep ocean_deep
cyber cyber
aurora aurora

GitHub Themes

Theme Description
github_light GitHub light mode
github_light_default GitHub light with gray titles
github_light_high_contrast GitHub light high contrast
github_light_colorblind GitHub light colorblind-friendly
github_light_tritanopia GitHub light tritanopia-friendly
github_dark GitHub dark mode
github_dark_default GitHub dark with white titles
github_dark_high_contrast GitHub dark high contrast
github_dark_dimmed GitHub dimmed dark
github_dark_colorblind GitHub dark colorblind-friendly
github_dark_tritanopia GitHub dark tritanopia-friendly

Popular Themes

Theme Description
default Light theme with blue accent
dark Pure dark theme
radical Pink/purple gradient
tokyonight Tokyo Night color scheme
dracula Dracula purple theme
nord Nord arctic colors
gruvbox Retro groove colors
onedark Atom One Dark theme
catppuccin_mocha Catppuccin Mocha
catppuccin_latte Catppuccin Latte
rose_pine Rose Pine theme

Editor Themes

Theme Description
monokai Monokai editor theme
cobalt Cobalt blue theme
cobalt2 Cobalt2 theme
nightowl Night Owl editor theme
material-palenight Material Palenight
darcula JetBrains Darcula
one_dark_pro One Dark Pro
ayu-mirage Ayu Mirage theme
noctis_minimus Noctis Minimus
synthwave 80s synthwave style

Framework & Brand Themes

Theme Description
vue Vue.js green theme
vue-dark Dark Vue.js theme
react React brand colors
swift Swift orange theme
algolia Algolia brand colors
discord_old_blurple Discord old blurple
buefy Buefy framework colors

Color Palette Themes

Theme Description
solarized-dark Solarized dark palette
solarized-light Solarized light palette
gruvbox_light Light gruvbox variant
shades-of-purple Purple shades theme
midnight-purple Midnight purple theme
blue-green Blue-green gradient
blue_navy Navy blue theme
calm Calm pastel colors
calm_pink Calm pink pastel
rose Rose pink theme

All Other Themes

Theme Description
default_repocard Light theme for repo cards
merko Green forest theme
highcontrast High contrast dark
prussian Prussian blue theme
great-gatsby Great Gatsby gold
bear Bear app theme
chartreuse-dark Chartreuse dark theme
gotham Gotham dark theme
graywhite Gray and white minimal
vision-friendly-dark Accessible dark theme
flag-india India flag colors
omni Omni dark theme
jolly Jolly bright theme
maroongold Maroon and gold
yeblu Yellow and blue
blueberry Blueberry colors
slateorange Slate and orange
kacho_ga Japanese aesthetic
outrun Outrun retro style
ocean_dark Deep ocean dark
city_lights City lights theme
aura_dark Aura dark theme
panda Panda syntax theme
aura Aura purple theme
apprentice Apprentice vim theme
moltack Moltack colors
codeSTACKr codeSTACKr theme
date_night Date night romantic
holi Holi festival colors
neon Cyan/magenta cyberpunk
ambient_gradient Ambient gradient

Streak Card Exclusive Themes

Modern themes designed specifically for the streak card:

Theme Description
sunset Warm sunset gradient
sunset_dark Dark sunset variant
ocean Ocean blue theme
ocean_deep Deep ocean theme
forest Forest green theme
forest_dark Dark forest variant
purple_wave Purple wave gradient
purple_galaxy Galaxy purple theme
cyber Cyberpunk neon
fire Fire red/orange theme
mint Fresh mint green
coral Coral pink theme
aurora Purple/teal aurora
golden Golden luxury theme
golden_dark Dark gold variant
rose_gold Rose gold elegant
electric Electric blue theme
lavender Soft lavender
arctic Arctic ice blue

Configuration

Configure via appsettings.json or environment variables:

  • GitHub API - Token and endpoint settings
  • Redis - Connection string for distributed caching
  • Cache TTL - Customizable cache duration per card type
  • Access Control - Whitelist/blacklist for users and repositories

License

MIT

About

📊 Real-time GitHub metrics for your profile and project READMEs

github-readme-stats.tuhidulhossain.com

Resources

Readme

Contributing

Contributing
Activity

Stars

4 stars

Watchers

0 watching

Forks

3 forks
Report repository

Sponsor this project

Packages

 
 
 

Contributors

Languages