Faq

FAQ

How do I create a Readme for my profile?

A profile readme appears on your profile page when you create a repository with the same name as your username and add a README.md file to it. For example, the repository for the user DenverCoder1 is located at DenverCoder1/DenverCoder1.

How do I include GitHub Readme Streak Stats in my Readme?

Markdown files on GitHub support embedded images using Markdown or HTML. You can customize your Streak Stats image on the demo site and use the image source in either of the following ways:

Markdown

[](https://git.io/streak-stats)

HTML

html

<a href="https://git.io/streak-stats"><img src="https://streak-stats.demolab.com?user=DenverCoder1"/></a>

Why doesn't my Streak Stats match my contribution graph?

GitHub Readme Streak Stats uses the GitHub API to fetch your contribution data. These stats are returned in UTC time which may not match your local time. Additionally, due to caching, the stats may not be updated immediately after a commit. You may need to wait up to a few hours to see the latest stats.

If you think your stats are not showing up because of a time zone issue, you can try one of the following:

1. Change the date of the commit. You can adjust the time of a past commit to make it in the middle of the day.
2. Create a new commit in a repository with the date set to the date that is missing from your streak stats:

bash

git commit --date="2022-08-02 12:00" -m "Test commit" --allow-empty
git push

What is considered a "contribution"?

Contributions include commits, pull requests, and issues that you create in standalone repositories (Learn more about what is considered a contribution).

The longest streak is the highest number of consecutive days on which you have made at least one contribution.

The current streak is the number of consecutive days ending with the current day on which you have made at least one contribution. If you have made a contribution today, it will be counted towards the current streak, however, if you have not made a contribution today, the streak will only count days before today so that your streak will not be zero.

Note: You may need to wait up to 24 hours for new contributions to show up (Learn how contributions are counted)

How do I enable private contributions?

To include contributions in private repositories, turn on the setting for "Private contributions" from the dropdown menu above the contribution graph on your profile page.

How do I center the image on the page?

To center align images, you must use the HTML syntax and wrap it in an element with the HTML attribute align="center".

html

<p align="center">
    <a href="https://git.io/streak-stats"><img src="https://streak-stats.demolab.com?user=DenverCoder1"/></a>
</p>

How do I make different images for dark mode and light mode?

You can specify theme context using the <picture> and <source> elements as shown below. The dark mode version appears in the srcset of the <source> tag and the light mode version appears in the src of the <img> tag.

html

<picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://streak-stats.demolab.com?user=DenverCoder1&theme=dark" />
    <img src="https://streak-stats.demolab.com?user=DenverCoder1&theme=default" />
</picture>

Why and how do I self-host GitHub Readme Streak Stats?

Self-hosting the code can be done online and only takes a couple minutes. The benefits include better uptime since it will use your own access token so will not run into ratelimiting issues and it allows you to customize the deployment for your own use case.

📺 Click here for a video tutorial on how to self-host on Vercel

See Deploying it on your own in the Readme for detailed instructions.

---

Themes

Currently supported themes

To enable a theme, append &theme= followed by the theme name to the end of your url.

You can also try out and customize these themes on the Demo Site!

Note: Theme names provided are case-insensitive and any use of underscores will be treated the same as hyphens.

Can't find the theme you like?

You can now customize your stats card with the interactive Demo Site or by customizing the url parameters.

If you would like to share your theme with others, feel free to open an issue/pull request!

Note: When submitting a new theme, make sure the name is all lowercase. Hyphens are allowed between words, but there should be no underscores. On the demo site, you can export a list of colors from the advanced section by clicking "Export to PHP".

---

CONTRIBUTING

Contributing Guidelines

Contributions are welcome! Feel free to open an issue or submit a pull request if you have a way to improve this project.

Make sure your request is meaningful and you have tested the app locally before submitting a pull request.

This documentation contains a set of guidelines to help you during the contribution process.

Need some help regarding the basics?

You can refer to the following articles on the basics of Git and GitHub in case you are stuck:

- Forking a Repo
- Cloning a Repo
- How to create a Pull Request
- Getting started with Git and GitHub
- Learn GitHub from Scratch

Installing Requirements

#### Requirements

- PHP 8.2+
- Composer
- Inkscape (for PNG rendering)

#### Linux

bash

sudo apt-get install php
sudo apt-get install php-curl
sudo apt-get install composer
sudo apt-get install inkscape

#### Windows

Install PHP from XAMPP or php.net

▶ How to install and run PHP using XAMPP (Windows)

📥 Download Composer

Clone the repository

text

git clone https://github.com/DenverCoder1/github-readme-streak-stats.git
cd github-readme-streak-stats

Authorization

To get the GitHub API to run locally you will need to provide a token.

1. Visit this link to create a new Personal Access Token
2. Scroll to the bottom and click "Generate token"
3. Make a copy of the .env.example named .env in the root directory and add your token after TOKEN=.

php

TOKEN=<your-token>

Install dependencies

Run the following command to install all the required dependencies to work on this project.

bash

composer install

Running the app locally

bash

composer start

Open http://localhost:8000/?user=DenverCoder1 to run the project locally

Open http://localhost:8000/demo/ to run the demo site

Running the tests

Run the following command to run the PHPUnit test script which will verify that the tested functionality is still working.

bash

composer test

Linting

This project uses Prettier for formatting PHP, Markdown, JavaScript and CSS files.

bash

Run prettier and show the files that need to be fixed

composer lint
Run prettier and fix the files

composer lint-fix

Submitting Contributions 👨‍💻

Below you will find the process and workflow used to review and merge your changes.

Step 0 : Find an issue

- Take a look at the existing issues or create your own issues!

Step 1 : Fork the Project

- Fork this repository. This will create a copy of this repository on your GitHub profile.
Keep a reference to the original project in the upstream remote.

bash

git clone https://github.com/<your-username>/github-readme-streak-stats.git
cd github-readme-streak-stats
git remote add upstream https://github.com/DenverCoder1/github-readme-streak-stats.git

- If you have already forked the project, update your copy before working.

bash

git remote update
git checkout <branch-name>
git rebase upstream/<branch-name>

Step 2 : Branch

Create a new branch. Use its name to identify the issue you're addressing.

bash

Creates a new branch with the name feature_name and switches to it

git checkout -b feature_name

Step 3 : Work on the issue assigned

- Work on the issue(s) assigned to you.
- Make all the necessary changes to the codebase.
- After you've made changes or made your contribution to the project, add changes to the branch you've just created using:

bash

To add all new files to the branch

git add .
To add only a few files to the branch

git add <some files (with path)>

Step 4 : Commit

- Commit a descriptive message using:

bash

This message will get associated with all files you have changed

git commit -m "message"

Step 5 : Work Remotely

- Now you are ready to your work on the remote repository.
- When your work is ready and complies with the project conventions, upload your changes to your fork:

bash

To push your work to your remote repository

git push -u origin Branch_Name

- Here is how your branch will look.

Step 6 : Pull Request

- Go to your forked repository in your browser and click on "Compare and pull request". Then add a title and description to your pull request that explains your contribution.

- Voila! Your Pull Request has been submitted and it's ready to be merged.🥳

#### Happy Contributing!

---

README

<img src="https://i.imgur.com/GZHodUG.png" width="100px"/>
<h3 align="center">Github Readme Streak Stats</h3>

Display your total contributions, current streak,
 
and longest streak on your GitHub profile README

⚡ Quick setup

Option 1: Web Deployment

1. Copy-paste the markdown below into your GitHub profile README
2. Replace the value after ?user= with your GitHub username

[](https://git.io/streak-stats)

#### Next Steps

- Check out the Demo Site or Options below for available customizations.

- It is recommended to self-host the project more better reliability. See Deploying it on your own for more details.

[ [][herokudeploy] [][verceldeploy]

Option 2: GitHub Actions

GitHub Actions can generate a static SVG in your profile repository so your README does not depend on the public hosted endpoint. If you need private contribution data, add a custom token to Repository Secrets using the steps below.

<details>
<summary>Adding a Custom Token to Repository Secrets</summary>

1. Visit this link to create a new Personal Access Token (no scopes required)
2. Scroll to the bottom and click "Generate token"
3. Visit your profile repository settings (Secrets and Variables > Actions) https://github.com/[YOUR USERNAME]/[YOUR USERNAME]/settings/secrets/actions
4. Click "New Repository Secret" and create a secret with a custom name (eg. STREAK_STATS_TOKEN) and your token from step 2 as the value.
5. Replace ${{ secrets.GITHUB_TOKEN }} in the yml file below with ${{ secrets.STREAK_STATS_TOKEN }} (using the custom name you gave the secret).

</details>

#### 1. Create the workflow file

Create a folder in your repo named .github and within it a folder named workflows and add a file /.github/workflows/streak-stats.yml in your profile repo (USERNAME/USERNAME):

yaml

name: Update streak stats on: schedule: - cron: "0 3 *" # Run every day at 03:00 push: paths: - ".github/workflows/streak-stats.yml" # Run any time this file is modified workflow_dispatch: # Run manually from the Actions tab jobs: build: runs-on: ubuntu-latest permissions: contents: write steps: - uses: actions/checkout@v4 - name: Generate streak stats uses: DenverCoder1/github-readme-streak-stats@main with: options: user=${{ github.repository_owner }}&theme=default&disable_animations=true path: profile/streak.svg token: ${{ secrets.GITHUB_TOKEN }}

- name: Commit streak stats run: | git config user.name "github-actions[bot]" git config user.email "41898282+github-actions[bot]@users.noreply.github.com" git add profile/streak.svg git commit -m "Update streak stats" || exit 0 git push

#### 2. Show the generated stats in your README

Add this to your profile README.md file where you want the stats to appear:

html

<a href="https://git.io/streak-stats"><img src="./profile/streak.svg" alt="GitHub Streak" /></a>

If you are using a fork, replace DenverCoder1 with the account or organization that hosts your fork. Do not put a PAT directly in the workflow file; store it in GitHub Secrets and reference it as ${{ secrets.YOUR_SECRET_NAME }}.

#### Next Steps

- Check out the Options below for available customizations.

⚙ Demo Site

Here you can customize your Streak Stats card with a live preview.

<https://streak-stats.demolab.com>

[](http://streak-stats.demolab.com/demo/)

🔧 Options

The user field is the only required option. All other fields are optional.

If the theme parameter is specified, any color customizations specified will be applied on top of the theme, overriding the theme's values.

🖌 Themes

To enable a theme, append &theme= followed by the theme name to the end of the source URL:

[](https://git.io/streak-stats)

If you have come up with a new theme you'd like to share with others, please see Issue #32 for more information on how to contribute.

🗪 Locales

The following are the locales that have labels translated in Streak Stats. The locale query parameter accepts any ISO language or locale code, see here for a list of valid locales. The locale provided will be used for the date format and number format even if translations are not yet available.

<table><tbody><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L37"><code>en</code></a> - English <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L37"><img src="https://progress-bar.xyz/100" alt="English 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L47"><code>am</code></a> - አማርኛ <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L47"><img src="https://progress-bar.xyz/100" alt="አማርኛ 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L56"><code>ar</code></a> - العربية <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L56"><img src="https://progress-bar.xyz/100" alt="العربية 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L67"><code>as</code></a> - অসমীয়া <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L67"><img src="https://progress-bar.xyz/100" alt="অসমীয়া 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L84"><code>bho</code></a> - भोजपुरी <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L84"><img src="https://progress-bar.xyz/100" alt="भोजपुरी 100%"></a></td></tr><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L93"><code>bn</code></a> - বাংলা <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L93"><img src="https://progress-bar.xyz/100" alt="বাংলা 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L102"><code>ca</code></a> - català <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L102"><img src="https://progress-bar.xyz/100" alt="català 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L111"><code>ceb</code></a> - Cebuano <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L111"><img src="https://progress-bar.xyz/100" alt="Cebuano 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L120"><code>da</code></a> - dansk <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L120"><img src="https://progress-bar.xyz/100" alt="dansk 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L129"><code>de</code></a> - Deutsch <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L129"><img src="https://progress-bar.xyz/100" alt="Deutsch 100%"></a></td></tr><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L138"><code>el</code></a> - Ελληνικά <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L138"><img src="https://progress-bar.xyz/100" alt="Ελληνικά 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L147"><code>es</code></a> - español <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L147"><img src="https://progress-bar.xyz/100" alt="español 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L156"><code>et</code></a> - eesti <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L156"><img src="https://progress-bar.xyz/100" alt="eesti 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L165"><code>fa</code></a> - فارسی <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L165"><img src="https://progress-bar.xyz/100" alt="فارسی 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L176"><code>fi</code></a> - suomi <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L176"><img src="https://progress-bar.xyz/100" alt="suomi 100%"></a></td></tr><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L185"><code>fil</code></a> - Filipino <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L185"><img src="https://progress-bar.xyz/100" alt="Filipino 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L194"><code>fr</code></a> - français <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L194"><img src="https://progress-bar.xyz/100" alt="français 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L203"><code>gu</code></a> - ગુજરાતી <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L203"><img src="https://progress-bar.xyz/100" alt="ગુજરાતી 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L212"><code>he</code></a> - עברית <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L212"><img src="https://progress-bar.xyz/100" alt="עברית 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L222"><code>hi</code></a> - हिन्दी <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L222"><img src="https://progress-bar.xyz/100" alt="हिन्दी 100%"></a></td></tr><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L239"><code>hu</code></a> - magyar <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L239"><img src="https://progress-bar.xyz/100" alt="magyar 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L256"><code>id</code></a> - Indonesia <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L256"><img src="https://progress-bar.xyz/100" alt="Indonesia 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L265"><code>it</code></a> - italiano <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L265"><img src="https://progress-bar.xyz/100" alt="italiano 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L274"><code>ja</code></a> - 日本語 <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L274"><img src="https://progress-bar.xyz/100" alt="日本語 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L285"><code>jv</code></a> - Jawa <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L285"><img src="https://progress-bar.xyz/100" alt="Jawa 100%"></a></td></tr><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L294"><code>kk</code></a> - қазақ тілі <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L294"><img src="https://progress-bar.xyz/100" alt="қазақ тілі 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L303"><code>kn</code></a> - ಕನ್ನಡ <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L303"><img src="https://progress-bar.xyz/100" alt="ಕನ್ನಡ 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L312"><code>ko</code></a> - 한국어 <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L312"><img src="https://progress-bar.xyz/100" alt="한국어 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L321"><code>mai</code></a> - मैथिली <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L321"><img src="https://progress-bar.xyz/100" alt="मैथिली 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L330"><code>mal</code></a> - മലയാളം <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L330"><img src="https://progress-bar.xyz/100" alt="മലയാളം 100%"></a></td></tr><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L340"><code>mi</code></a> - Māori <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L340"><img src="https://progress-bar.xyz/100" alt="Māori 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L349"><code>mr</code></a> - मराठी <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L349"><img src="https://progress-bar.xyz/100" alt="मराठी 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L358"><code>ms</code></a> - Melayu <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L358"><img src="https://progress-bar.xyz/100" alt="Melayu 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L367"><code>ms_ID</code></a> - Melayu (Indonesia) <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L367"><img src="https://progress-bar.xyz/100" alt="Melayu (Indonesia) 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L376"><code>my</code></a> - မြန်မာ <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L376"><img src="https://progress-bar.xyz/100" alt="မြန်မာ 100%"></a></td></tr><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L385"><code>ne</code></a> - नेपाली <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L385"><img src="https://progress-bar.xyz/100" alt="नेपाली 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L394"><code>nl</code></a> - Nederlands <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L394"><img src="https://progress-bar.xyz/100" alt="Nederlands 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L403"><code>no</code></a> - norsk <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L403"><img src="https://progress-bar.xyz/100" alt="norsk 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L412"><code>pa</code></a> - ਪੰਜਾਬੀ <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L412"><img src="https://progress-bar.xyz/100" alt="ਪੰਜਾਬੀ 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L421"><code>pl</code></a> - polski <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L421"><img src="https://progress-bar.xyz/100" alt="polski 100%"></a></td></tr><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L430"><code>ps</code></a> - پښتو <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L430"><img src="https://progress-bar.xyz/100" alt="پښتو 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L441"><code>pt</code></a> - português <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L441"><img src="https://progress-bar.xyz/100" alt="português 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L450"><code>pt_BR</code></a> - português (Brasil) <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L450"><img src="https://progress-bar.xyz/100" alt="português (Brasil) 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L459"><code>ro</code></a> - română <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L459"><img src="https://progress-bar.xyz/100" alt="română 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L468"><code>ru</code></a> - русский <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L468"><img src="https://progress-bar.xyz/100" alt="русский 100%"></a></td></tr><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L485"><code>sa</code></a> - संस्कृत भाषा <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L485"><img src="https://progress-bar.xyz/100" alt="संस्कृत भाषा 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L494"><code>sd_PK</code></a> - سنڌي (پاڪستان) <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L494"><img src="https://progress-bar.xyz/100" alt="سنڌي (پاڪستان) 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L506"><code>sr_Cyrl</code></a> - српски (ћирилица) <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L506"><img src="https://progress-bar.xyz/100" alt="српски (ћирилица) 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L515"><code>sr_Latn</code></a> - srpski (latinica) <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L515"><img src="https://progress-bar.xyz/100" alt="srpski (latinica) 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L524"><code>su</code></a> - Basa Sunda <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L524"><img src="https://progress-bar.xyz/100" alt="Basa Sunda 100%"></a></td></tr><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L533"><code>sv</code></a> - svenska <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L533"><img src="https://progress-bar.xyz/100" alt="svenska 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L542"><code>sw</code></a> - Kiswahili <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L542"><img src="https://progress-bar.xyz/100" alt="Kiswahili 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L551"><code>ta</code></a> - தமிழ் <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L551"><img src="https://progress-bar.xyz/100" alt="தமிழ் 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L560"><code>tcy</code></a> - Tulu <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L560"><img src="https://progress-bar.xyz/100" alt="Tulu 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L569"><code>te</code></a> - తెలుగు <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L569"><img src="https://progress-bar.xyz/100" alt="తెలుగు 100%"></a></td></tr><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L578"><code>th</code></a> - ไทย <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L578"><img src="https://progress-bar.xyz/100" alt="ไทย 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L587"><code>tr</code></a> - Türkçe <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L587"><img src="https://progress-bar.xyz/100" alt="Türkçe 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L596"><code>uk</code></a> - українська <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L596"><img src="https://progress-bar.xyz/100" alt="українська 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L605"><code>ur_PK</code></a> - اردو (پاکستان) <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L605"><img src="https://progress-bar.xyz/100" alt="اردو (پاکستان) 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L616"><code>vi</code></a> - Tiếng Việt <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L616"><img src="https://progress-bar.xyz/100" alt="Tiếng Việt 100%"></a></td></tr><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L625"><code>yo</code></a> - Èdè Yorùbá <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L625"><img src="https://progress-bar.xyz/100" alt="Èdè Yorùbá 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L635"><code>zh_Hans</code></a> - 中文（简体） <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L635"><img src="https://progress-bar.xyz/100" alt="中文（简体） 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L645"><code>zh_Hant</code></a> - 中文（繁體） <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L645"><img src="https://progress-bar.xyz/100" alt="中文（繁體） 100%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L76"><code>bg</code></a> - български <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L76"><img src="https://progress-bar.xyz/86" alt="български 86%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L231"><code>ht</code></a> - créole haïtien <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L231"><img src="https://progress-bar.xyz/86" alt="créole haïtien 86%"></a></td></tr><tr><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L248"><code>hy</code></a> - հայերեն <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L248"><img src="https://progress-bar.xyz/86" alt="հայերեն 86%"></a></td><td><a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L477"><code>rw</code></a> - Kinyarwanda <a href="https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/src/translations.php#L477"><img src="https://progress-bar.xyz/86" alt="Kinyarwanda 86%"></a></td><td></td><td></td><td></td></tr></tbody></table>

If you would like to help translate the Streak Stats cards, please see Issue #236 for more information.

📅 Date Formats

If date_format is not provided or is empty, the PHP Intl library is used to determine the date format based on the locale specified in the locale query parameter.

A custom date format can be specified by passing a string to the date_format parameter.

The required format is to use format string characters from PHP's date function with brackets around the part representing the year.

When the contribution year is equal to the current year, the characters in brackets will be omitted.

Examples:

Example

[](https://git.io/streak-stats)

ℹ️ How these stats are calculated

This tool uses the contribution graphs on your GitHub profile to calculate which days you have contributed.

To include contributions in private repositories, turn on the setting for "Private contributions" from the dropdown menu above the contribution graph on your profile page.

Contributions include commits, pull requests, and issues that you create in standalone repositories.

The longest streak is the highest number of consecutive days on which you have made at least one contribution.

NOTE

You may need to wait up to 24 hours for new contributions to show up (Learn how contributions are counted)

📤 Deploying it on your own

It is preferable to either use GitHub Actions, or host the files on your own server which takes less than 2 minutes to set up.

Doing this can lead to better uptime and more control over customization (you can modify the code for your usage).

You can deploy the PHP files on any website server with PHP installed including Heroku and Vercel.

The Inkscape dependency is required for PNG rendering, as well as Segoe UI font for the intended rendering. If using Heroku, the buildpacks will install these for you automatically.

Deploy to Vercel

Vercel is the recommended option for hosting the files since it is free and easy to set up. Watch the video below or expand the instructions to learn how to deploy to Vercel.

NOTE

PNG mode is not supported since Inkscape will not be installed but the default SVG mode will work.

📺 Click here for a video tutorial on how to self-host on Vercel

<details>
<summary>Instructions for deploying to Vercel (Free)</summary>

Step-by-step instructions for deploying to Vercel

#### Option 1: Deploy to Vercel quickly with the Deploy button (recommended)

IMPORTANT

Make sure that you host the vercel branch as otherwise you'll get a 404 error from Vercel. You can set the vercel branch as default after forking the repo.

1. Click the Deploy button below

[ [][verceldeploy]

2. Create your repository by filling in a Repository Name and clicking "Create"
3. Visit this link to create a new Personal Access Token (no scopes required)
4. Scroll to the bottom and click "Generate token"
5. Add the token as a Config Var with the key TOKEN:

6. Click "Deploy" at the end of the form
7. Once the app is deployed, click the screenshot of your app or continue to the dashboard to find your domain to use in place of streak-stats.demolab.com

#### Option 2: Deploy to Vercel manually

1. Sign in to Vercel or create a new account at <https://vercel.com>
2. Use the following command to clone the repository: git clone https://github.com/DenverCoder1/github-readme-streak-stats.git. If you plan to make changes, you can also fork the repository and clone your fork instead. If you do not have Git installed, you can download it from <https://git-scm.com/downloads>.
3. Navigate to the cloned repository's directory using the command cd github-readme-streak-stats
4. Switch to the "vercel" branch using the command git checkout vercel
5. Make sure you have the Vercel CLI (Command Line Interface) installed on your system. If not, you can download it from <https://vercel.com/download>.
6. Run the command vercel and follow the prompts to link your Vercel account and choose a project name
7. After successful deployment, your app will be available at <project-name>.vercel.app
8. Open this link to create a new Personal Access Token on GitHub. You don't need to select any scopes for the token.
9. Scroll to the bottom of the page and click on "Generate token"
10. Visit the Vercel dashboard at <https://vercel.com/dashboard> and select your project. Then, click on "Settings" and choose "Environment Variables".
11. Add a new environment variable with the key TOKEN and the value as the token you generated in step 9, then save your changes
12. (Optional) You can also set the WHITELIST environment variable to restrict which GitHub usernames can be accessed through the service. Provide the usernames as a comma-separated list, for example: user1,user2,user3. If the variable is not set, information can be requested for any GitHub user.
13. To apply the new environment variable(s), you need to redeploy the app. Run vercel --prod to deploy the app to production.

⚠️ Note

To set up automatic Vercel deployments from GitHub, make sure to turn off "Include source files outside of the Root Directory" in the General settings and use vercel as the production branch in the Git settings.

</details>

Deploy on Heroku

Heroku is another great option for hosting the files. All features are supported on Heroku and it is where the default domain is hosted. Heroku is not free, however, and you will need to pay between \$5 and \$7 per month to keep the app running. Expand the instructions below to learn how to deploy to Heroku.

<details>
<summary>Instructions for deploying to Heroku (Paid)</summary>

Step-by-step instructions for deploying to Heroku

1. Sign in to Heroku or create a new account at <https://heroku.com>
2. Visit this link to create a new Personal Access Token (no scopes required)
3. Scroll to the bottom and click "Generate token"
4. Click the Deploy button below

[ [][herokudeploy]

5. Add the token as a Config Var with the key TOKEN:

6. (Optional) You can also set the WHITELIST Config Var to restrict which GitHub usernames can be accessed through the service. Provide the usernames as a comma-separated list, for example: user1,user2,user3. If the variable is not set, information can be requested for any GitHub user.
7. Click "Deploy App" at the end of the form
8. Once the app is deployed, you can use <your-app-name>.herokuapp.com in place of streak-stats.demolab.com

</details>

Deploy on your own

You can transfer the files to any webserver using FTP or other means, then refer to CONTRIBUTING.md for installation steps.

🐳 Docker

Docker is a great option for self-hosting with full control over your environment. All features are supported including PNG rendering with Inkscape. Expand the instructions below to learn how to deploy with Docker.

<details>
<summary>Instructions for deploying with Docker</summary>

Step-by-step instructions for deploying with Docker

1. Clone the repository:

bash

git clone https://github.com/DenverCoder1/github-readme-streak-stats.git
   cd github-readme-streak-stats

2. Visit https://github.com/settings/tokens/new?description=GitHub%20Readme%20Streak%20Stats to create a new Personal Access Token (no scopes required)

3. Scroll to the bottom and click "Generate token"

4. Build the Docker image:

bash

docker build -t streak-stats .

5. Run the container with your GitHub token:

bash

docker run -d -p 8080:80 -e TOKEN=your_github_token_here streak-stats

6. You can also optionally set the WHITELIST environment variable to restrict which GitHub usernames can be accessed through the service. If the WHITELIST variable is not set, information can be requested for any GitHub user.
Provide the usernames as a comma-separated list, for example:

bash

docker run -d -p 8080:80 -e TOKEN=your_github_token_here -e WHITELIST=user1,user2,user3 streak-stats

7. Visit http://localhost:8080 to access your self-hosted instance

</details>

[hspace]: https://user-images.githubusercontent.com/20955511/136058102-b79570bc-4912-4369-b664-064a0ada8588.png
[verceldeploy]: https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FDenverCoder1%2Fgithub-readme-streak-stats%2Ftree%2Fvercel&env=TOKEN&envDescription=GitHub%20Personal%20Access%20Token%20(no%20scopes%20required)&envLink=https%3A%2F%2Fgithub.com%2Fsettings%2Ftokens%2Fnew%3Fdescription%3DGitHub%2520Readme%2520Streak%2520Stats&project-name=streak-stats&repository-name=github-readme-streak-stats
[herokudeploy]: https://heroku.com/deploy?template=https://github.com/DenverCoder1/github-readme-streak-stats/tree/main

🤗 Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request if you have a way to improve this project.

Make sure your request is meaningful and you have tested the app locally before submitting a pull request.

Refer to CONTRIBUTING.md for more details on contributing, installing requirements, and running the application.

🙋‍♂️ Support

💙 If you like this project, give it a ⭐ and share it with friends!

☕ Buy me a coffee

---

Made with ❤️ and PHP

---

Faq Copy Section

FAQ

How do I create a Readme for my profile? Copy Chapter

How do I include GitHub Readme Streak Stats in my Readme? Copy Chapter

Markdown Copy Section

HTML Copy Section

Why doesn't my Streak Stats match my contribution graph? Copy Chapter

What is considered a "contribution"? Copy Chapter

How do I enable private contributions? Copy Chapter

How do I center the image on the page? Copy Chapter

How do I make different images for dark mode and light mode? Copy Chapter

Why and how do I self-host GitHub Readme Streak Stats? Copy Chapter

📺 Click here for a video tutorial on how to self-host on Vercel 📺 Click here for a video tutorial on how to self-host on Vercel')" title="Copy section prompt for LLMs"> Copy Section

Themes Copy Section

Currently supported themes Copy Chapter

Can't find the theme you like? Copy Section

CONTRIBUTING Copy Section

Contributing Guidelines Copy Chapter

Need some help regarding the basics? Copy Section

Installing Requirements Copy Section

Clone the repository Copy Section

Authorization Copy Section

Install dependencies Copy Section

Running the app locally Copy Section

Running the tests Copy Section

Linting Copy Chapter

Run prettier and show the files that need to be fixed

Run prettier and fix the files

Submitting Contributions 👨‍💻 Copy Chapter

Step 0 : Find an issue Copy Section

Step 1 : Fork the Project Copy Section

Step 2 : Branch Copy Section

Creates a new branch with the name feature_name and switches to it

Step 3 : Work on the issue assigned Copy Section

To add all new files to the branch

To add only a few files to the branch

Step 4 : Commit Copy Section

This message will get associated with all files you have changed

Step 5 : Work Remotely Copy Section

To push your work to your remote repository

Step 6 : Pull Request Copy Section

README Copy Section

⚡ Quick setup Copy Chapter

Option 1: Web Deployment Copy Section

Option 2: GitHub Actions Copy Section

⚙ Demo Site Copy Chapter

🔧 Options Copy Chapter

🖌 Themes Copy Section

🗪 Locales Copy Section

📅 Date Formats Copy Section

Example Copy Section

ℹ️ How these stats are calculated Copy Chapter

📤 Deploying it on your own Copy Chapter

Deploy to Vercel Copy Section

📺 Click here for a video tutorial on how to self-host on Vercel Click here for a video tutorial on how to self-host on Vercel')" title="Copy section prompt for LLMs"> Copy Section

Step-by-step instructions for deploying to Vercel Copy Section

Deploy on Heroku Copy Section

Step-by-step instructions for deploying to Heroku Copy Section

Deploy on your own Copy Section

🐳 Docker Copy Section

Step-by-step instructions for deploying with Docker Copy Section

🤗 Contributing Copy Chapter

🙋‍♂️ Support Copy Chapter

Explore Related Technologies & Topics

Faq

How do I create a Readme for my profile?

How do I include GitHub Readme Streak Stats in my Readme?

Markdown

HTML

Why doesn't my Streak Stats match my contribution graph?

What is considered a "contribution"?

How do I enable private contributions?

How do I center the image on the page?

How do I make different images for dark mode and light mode?

Why and how do I self-host GitHub Readme Streak Stats?

📺 Click here for a video tutorial on how to self-host on Vercel

Themes

Currently supported themes

Can't find the theme you like?

CONTRIBUTING

Contributing Guidelines

Need some help regarding the basics?

Installing Requirements

Clone the repository

Authorization

Install dependencies

Running the app locally

Running the tests

Linting

Submitting Contributions 👨‍💻

Step 0 : Find an issue

Step 1 : Fork the Project

Step 2 : Branch

Step 3 : Work on the issue assigned

Step 4 : Commit

Step 5 : Work Remotely

Step 6 : Pull Request

README

⚡ Quick setup

Option 1: Web Deployment

Option 2: GitHub Actions

⚙ Demo Site

🔧 Options

🖌 Themes

🗪 Locales

📅 Date Formats

Example

ℹ️ How these stats are calculated

📤 Deploying it on your own

Deploy to Vercel

📺 Click here for a video tutorial on how to self-host on Vercel

Step-by-step instructions for deploying to Vercel

Deploy on Heroku

Step-by-step instructions for deploying to Heroku

Deploy on your own

🐳 Docker

Step-by-step instructions for deploying with Docker

🤗 Contributing

🙋‍♂️ Support