{"id":51002598,"url":"https://github.com/muhammad-fiaz/github-readme-streak-stats","last_synced_at":"2026-06-20T16:32:39.674Z","repository":{"id":336186762,"uuid":"1147211668","full_name":"muhammad-fiaz/github-readme-streak-stats","owner":"muhammad-fiaz","description":"Display your total contributions, current streak, and longest streak on your GitHub profile README with beautiful themes and animations!","archived":false,"fork":false,"pushed_at":"2026-02-03T06:50:02.000Z","size":101,"stargazers_count":6,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-22T15:40:32.212Z","etag":null,"topics":["git-stats","github","github-readme-streak-stats","github-streak","streak-github","streak-tracker","streak-tracking"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/muhammad-fiaz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-01T11:43:55.000Z","updated_at":"2026-02-03T06:49:15.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/muhammad-fiaz/github-readme-streak-stats","commit_stats":null,"previous_names":["muhammad-fiaz/github-readme-streak-stats"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/muhammad-fiaz/github-readme-streak-stats","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhammad-fiaz%2Fgithub-readme-streak-stats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhammad-fiaz%2Fgithub-readme-streak-stats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhammad-fiaz%2Fgithub-readme-streak-stats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhammad-fiaz%2Fgithub-readme-streak-stats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/muhammad-fiaz","download_url":"https://codeload.github.com/muhammad-fiaz/github-readme-streak-stats/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muhammad-fiaz%2Fgithub-readme-streak-stats/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34578089,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-20T02:00:06.407Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["git-stats","github","github-readme-streak-stats","github-streak","streak-github","streak-tracker","streak-tracking"],"created_at":"2026-06-20T16:32:38.806Z","updated_at":"2026-06-20T16:32:39.647Z","avatar_url":"https://github.com/muhammad-fiaz.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Readme Streak Stats\n\n[![Version](https://img.shields.io/badge/version-1.0.1-blue.svg)](https://github.com/muhammad-fiaz/github-readme-streak-stats)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Test](https://github.com/muhammad-fiaz/github-readme-streak-stats/actions/workflows/test.yml/badge.svg)](https://github.com/muhammad-fiaz/github-readme-streak-stats/actions/workflows/test.yml)\n\nDisplay your total contributions, current streak, and longest streak on your GitHub profile README with beautiful themes and animations!\n\n# Demo\n\n\u003cimg  alt=\"demo image\" src=\"https://github.com/user-attachments/assets/47b6d233-2211-4563-b738-26e340ecff5a\" /\u003e\n\n## Features\n\n- **150+ Predefined Themes** - From popular editor themes to custom gradients\n- **Gradient Support** - Linear gradients with customizable angles\n- **Transparent Backgrounds** - Perfect for any README background\n- **Bun Runtime** - Fast and modern JavaScript runtime\n- **Zero Dependencies** - Pure TypeScript, no external packages needed\n- **Animated SVG** - Smooth fade-in and pulse animations\n- **Type-Safe** - Full TypeScript support with strict types\n\n## Usage\n\nUse this GitHub Action to generate your streak stats card and save it to your repository.\n\n### Workflow Example\n\nThis workflow will generate two versions of your streak stats (Dark \u0026 Light) and push them to an `output` branch. You can then use them in your README.\n\nCreate a workflow file (e.g., `.github/workflows/streak-stats.yml`):\n\n```yaml\nname: Generate Streak Stats\n\non:\n  schedule:\n    - cron: \"0 0 * * *\" # Run daily at midnight\n  workflow_dispatch:\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    permissions:\n      contents: write\n    steps:\n      - uses: actions/checkout@v5\n\n      - name: Generate Streak Stats (Dark)\n        uses: muhammad-fiaz/github-readme-streak-stats@v1.0.1\n        with:\n          USERNAME: ${{ secrets.USER_NAME }}\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          THEME: tokyonight\n          OUTPUT_PATH: github-streak-stats-dark.svg\n\n      - name: Generate Streak Stats (Light)\n        uses: muhammad-fiaz/github-readme-streak-stats@v1.0.1\n        with:\n          USERNAME: ${{ secrets.USER_NAME }}\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          THEME: default\n          OUTPUT_PATH: github-streak-stats-light.svg\n\n      - name: Push to output branch\n        uses: crazy-max/ghaction-github-pages@v4.2.0\n        with:\n          target_branch: output\n          build_dir: .\n          keep_history: true\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n### Embed in README\n\nOnce the `output` branch is created (after the first run of the workflow), you can use the following HTML to display the card with automatic dark/light mode support:\n\n```html\n\u003cdiv style=\"display: flex; justify-content: center; align-items: center;\"\u003e\n  \u003cpicture\u003e\n    \u003csource\n      media=\"(prefers-color-scheme: dark)\"\n      srcset=\"\n        https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_REPO/output/github-streak-stats-dark.svg\n      \"\n    /\u003e\n    \u003csource\n      media=\"(prefers-color-scheme: light)\"\n      srcset=\"\n        https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_REPO/output/github-streak-stats-light.svg\n      \"\n    /\u003e\n    \u003cimg\n      alt=\"github-streak-stats\"\n      src=\"https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_REPO/output/github-streak-stats-dark.svg\"\n    /\u003e\n  \u003c/picture\u003e\n\u003c/div\u003e\n```\n\n\u003e **Note**: Replace `YOUR_USERNAME` and `YOUR_REPO` with your actual details.\n\n## Demo\n\nA demo workflow is available in [workflow-demo.yml](workflow-demo.yml) that showcases the action running daily to generate streak stats and push them to a demo branch.\n\n## Inputs\n\n| Input           | Description                             | Required | Default             |\n| --------------- | --------------------------------------- | -------- | ------------------- |\n| `USERNAME`      | Your GitHub username                    | **Yes**  | N/A                 |\n| `GITHUB_TOKEN`  | Your GitHub token (PAT or GITHUB_TOKEN) | **Yes**  | N/A                 |\n| `THEME`         | Theme name (e.g., `default`, `dracula`) | No       | `default`           |\n| `OUTPUT_PATH`   | Path to save the SVG file               | No       | `github-streak.svg` |\n| `ANIMATED`      | Enable animations (`true` or `false`)   | No       | `true`              |\n| `LOCALE`        | Locale code (e.g., `en`, `ja`)          | No       | `en`                |\n| `DATE_FORMAT`   | Date format string                      | No       | `M j[, Y]`          |\n| `HIDE_BORDER`   | Hide the border (`true` or `false`)     | No       | `false`             |\n| `BORDER_RADIUS` | Corner radius                           | No       | `4.5`               |\n| `CARD_WIDTH`    | Card width                              | No       | `495`               |\n| `CARD_HEIGHT`   | Card height                             | No       | `195`               |\n\n### Custom Color Overrides\n\nYou can also override specific colors:\n\n| Input               | Description                  |\n| ------------------- | ---------------------------- |\n| `RING`              | Ring/Circle color            |\n| `FIRE`              | Fire icon color              |\n| `BACKGROUND`        | Background color or gradient |\n| `STROKE`            | Border color                 |\n| `CURR_STREAK_NUM`   | Current streak number color  |\n| `SIDE_NUMS`         | Side stats numbers color     |\n| `CURR_STREAK_LABEL` | All label texts color        |\n| `DATES`             | Dates text color             |\n\n## Available Themes\n\n### Popular Themes\n\n| Theme        | Description                     |\n| ------------ | ------------------------------- |\n| `default`    | Light theme with orange accents |\n| `dark`       | Dark theme with orange accents  |\n| `tokyonight` | Tokyo Night color scheme        |\n| `dracula`    | Dracula color scheme            |\n| `nord`       | Nord color scheme               |\n| `gruvbox`    | Gruvbox color scheme            |\n\n### Gradient Themes\n\n| Theme               | Description                |\n| ------------------- | -------------------------- |\n| `sunset-gradient`   | Orange-pink-purple sunset  |\n| `ocean-gradient`    | Blue-cyan ocean vibes      |\n| `ambient-gradient`  | Purple-pink-yellow ambient |\n| `telegram-gradient` | Telegram brand colors      |\n| `cyber-streakglow`  | Cyberpunk neon colors      |\n\n### Checks for Gradient Background\n\nIt supports 3 types of background:\n\n- **Solid**: `#ff0000`\n- **Transparent**: `transparent` or `#0000`\n- **Gradient**: `45,ff0000,00ff00` (Angle, Start Color, End Color)\n\n## License\n\nMIT License - feel free to use in your own projects!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuhammad-fiaz%2Fgithub-readme-streak-stats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuhammad-fiaz%2Fgithub-readme-streak-stats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuhammad-fiaz%2Fgithub-readme-streak-stats/lists"}