https://github.com/levvolkov/github_stats
A generator for GitHub user/repo SVG stats for embedding in README or websites.
https://github.com/levvolkov/github_stats
api badges generator github github-statistics github-stats github-stats-card github-stats-svg handlebars javascript node-js profile readme readme-profile stats svg-animations visualization
Last synced: 5 months ago
JSON representation
A generator for GitHub user/repo SVG stats for embedding in README or websites.
- Host: GitHub
- URL: https://github.com/levvolkov/github_stats
- Owner: levvolkov
- License: mit
- Created: 2025-07-05T11:09:20.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-08-22T21:14:50.000Z (5 months ago)
- Last Synced: 2025-08-22T21:45:21.794Z (5 months ago)
- Topics: api, badges, generator, github, github-statistics, github-stats, github-stats-card, github-stats-svg, handlebars, javascript, node-js, profile, readme, readme-profile, stats, svg-animations, visualization
- Language: Handlebars
- Homepage:
- Size: 445 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Stats Cards
Generate SVG cards with GitHub statistics (commits, stars, unique visitors, and more) that you can use in your profile or repository README.
## Features
- **Efficiently fetch user statistics:** Using GitHub's GraphQL and REST APIs.
- **Generate informative SVGs:** Display stars, forks, contributions, lines changed, views, and other metrics.
- **Hourly automatic updates:** Regenerate images automatically each hour if changes occur.
- **Manual triggering anytime:** Launch the workflow manually through GitHub Actions whenever desired.
- **Default setting includes all repositories:** By default, statistics include all your repositories, including forks.
- **Customizable exclusions:** Easily add exclusions for specific repositories or forked projects.
- **Styling customization:** Change styles and colors of statistic cards according to preferences.
- **Dark/Light theme support:** Visualize data in both light and dark modes within SVG outputs.
## Installation and Usage
1. **Create a personal [GitHub access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens):**
- Go to: **Settings** → **Developer settings** →
**Personal access tokens** → **Tokens (classic)** →
**Generate new token** → **Generate new token (classic)**
- Set the expiration date for your GitHub personal token. After expiration, you will need to update the token for the workflow to work correctly.
- Set the following permissions:
- [x] **repo**
- [x] **read:user**
- Copy the token right after creation — you will not be able to view it again.
2. **Create a repository from the template:**
- Click [Use this template](https://github.com/levvolkov/github_stats/generate) and create a new repository based on the template.
> [!NOTE]\
> Next, for a more comfortable project setup, you will need to follow the steps and use the links while in `README.md` of your copy of the template.
3. **Add the token as a secret to your repository:**
- Go to the **Settings** tab of your new repository.
- In the left menu, select **Secrets and variables** → **Actions** or use [this link](../../settings/secrets/actions).
- Click **New repository secret**.
- In the **Name** field, enter: `ACCESS_TOKEN`.
- In the **Value** field, paste the previously copied personal access token.
- Save the secret.
4. **Run the workflow to generate statistics:**
- Go to the **[Actions](../../actions/workflows/update-stats.yml)** tab of your repository.
- Select the **Update GitHub stats SVG** workflow from the list on the left.
- Click the **Run workflow** button (top right corner).
5. **Add the statistics to your GitHub profile README:**
- Copy and paste the following code blocks into your markdown content.
- Change the `username` value to your GitHub username.
- Change the `repository_name` value to the name of your GitHub repository where the svg is generated.
```md
```
```md
```
```md
```
```md
```
> [!WARNING]\
> Some GitHub statistics (views, unique visitors, traffic) are updated with a delay due to GitHub API limitations!
## Customizing the displayed statistics
1. **Ignoring certain languages**
- Go to the **Settings** tab of your new repository.
- In the left menu, select **Secrets and variables** → **Actions** or use [this link](../../settings/secrets/actions).
- Click **New repository secret**.
- In the **Name** field, enter: `EXCLUDED_LANGS`.
- In the **Value** field, enter a comma-separated list of languages you want to exclude from statistics, for example: `html, tex`.
- Save the secret and re-run the [workflow](../../actions/workflows/update-stats.yml).
2. **Ignore specific repositories or forks**
- Go to the **Settings** tab of your new repository.
- In the left menu, select **Secrets and variables** → **Actions** or use [this link](../../settings/secrets/actions).
- Click **New repository secret**.
- In the **Name** field, enter: `EXCLUDED_REPOS`.
- In the **Value** field, enter a comma-separated list of repositories that you want to exclude from statistics, for example: `github_stats`.
- Save the secret and re-run the [workflow](../../actions/workflows/update-stats.yml).
## Customizing SVG Styles
The appearance settings are stored in the [`themes/`](themes/) folder. You can easily change the [colors](https://colorscheme.ru/html-colors.html), set a card background, or change the time zone in the [Commit series](themes/colors_commits.js#L30) card to any of the [supported time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Additionally, you can disable the time zone display altogether by setting the value to `"none"`.
1. **Where to configure**
colors_commits.js
colors_langs.js
colors_general.js
colors_visitors.js
Commit series
Programming languages
General statistics
Unique repository visitors
2. **How to change**
- Open the desired [style file](themes/) in your copy of the repository.
- Change the values as you wish.
- Save the file and re-run the [workflow](../../actions/workflows/update-stats.yml) (if it doesn't start automatically).