DenverCoder1/github-readme-streak-stats
Github Readme Streak Stats
This project is a GitHub contribution streak tracker and profile README statistic generator. It functions as a deployable server that calculates consecutive days of commits, pull requests, and issues to produce dynamic visual cards displaying a user's total, current, and longest activity streaks.
The tool generates customizable SVG activity stat cards that can be embedded directly into profile overviews. It features a parameter-driven theme engine for modifying colors and borders, as well as localization support for translating labels and formatting dates.
The system includes configurable streak calculation logic, allowing users to define time intervals and exclude specific days of the week. It also provides a whitelist-based access control mechanism to restrict data access to authorized usernames.
This application supports self-hosting on private servers or cloud platforms to maintain control over data privacy and customization.
Features
- Contribution Streak Tracking - Calculates consecutive days of activity based on commits, pull requests, and issues across repositories.
- Profile Statistic Servers - Provides a deployable server that generates and hosts dynamic GitHub activity statistic cards for user profiles.
- GitHub Profile Integrations - Provides tools to visualize GitHub-specific activity and metrics within a profile README.
- Activity Summaries - Generates condensed summaries of contribution activity to be embedded in profile overviews.
- GitHub API Integrations - Fetches user contribution data via REST endpoints to calculate activity streaks and total commit counts.
- Contribution Tracking - Tracks and visualizes daily streaks of commits and pull requests to monitor activity.
- GitHub Stats Cards - Renders visual widgets showing total, current, and longest activity streaks for GitHub profiles.
- SVG Element Generators - Programmatically generates SVG markup to render activity statistics as vector graphics.
- Request Handling - Processes incoming HTTP requests and parameters to dynamically render customized statistical cards.
- Profile Statistics Generators - Generates dynamic visual representations of user activity for profile documentation.
- Portfolio Enhancement Tools - Improves developer profiles with dynamic graphics that highlight long-term engagement and project activity.
- Streak Calculation Logic - Allows users to define how activity streaks are counted by adjusting time intervals and excluded days.
- Self-Hosted Deployment Platforms - Supports deployment on private servers or cloud platforms for full control over customization.
- Static Graphic Generators - GitHub Readme Stats generates static vector graphics of activity data to eliminate dependence on external hosting and protect private information.
- Query-Parameter-Driven Configurations - Uses URL query parameters to dynamically modify the colors and borders of the generated statistics cards.
- Chart Visual Style Customizations - Provides thematic and aesthetic modifications for colors, borders, and animations of activity charts.
- Developer Tools - Visual tracker for GitHub contribution streaks.
- Profile Readme Tools - Displays contribution streak metrics.
