DenverCoder1/github-readme-streak-stats
DenverCoder1/github-readme-streak-stats là một trong những repo phía máy chủ mà TopGit theo dõi, hiện có 7.1k sao, viết chủ yếu bằng PHP. 🔥 Stay motivated and show off your contribution streak! 🌟 Display your total contributions, current streak, and longest streak on your GitHub profile README
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
Snapshot
Cộng tác viên hàng đầu
Xem cộng tác viên hàng đầu
Github Readme Streak Stats
Display your total contributions, current streak,
and longest streak on your GitHub profile README
⚡ Quick setup
Option 1: Web Deployment
- Copy-paste the markdown below into your GitHub profile README
- 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.
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.
Adding a Custom Token to Repository Secrets
- Visit this link to create a new Personal Access Token (no scopes required)
- Scroll to the bottom and click "Generate token"
- Visit your profile repository settings (Secrets and Variables > Actions)
https://github.com/[YOUR USERNAME]/[YOUR USERNAME]/settings/secrets/actions - 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. - Replace
${{ secrets.GITHUB_TOKEN }}in the yml file below with${{ secrets.STREAK_STATS_TOKEN }}(using the custom name you gave the secret).
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):
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:
<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
🔧 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.
| Parameter | Details | Example |
|---|---|---|
user | GitHub username to show stats for | DenverCoder1 |
theme | The theme to apply (Default: default) | dark, radical, etc. 🎨➜ |
hide_border | Make the border transparent (Default: false) | true or false |
border_radius | Set the roundness of the edges (Default: 4.5) | Number 0 (sharp corners) to 248 (ellipse) |
background | Background color (eg. f2f2f2, 35,d22,00f) | hex code without #, css color, or gradient in the form angle,start_color,...,end_color |
border | Border color | hex code without # or css color |
stroke | Stroke line color between sections | hex code without # or css color |
ring | Color of the ring around the current streak | hex code without # or css color |
fire | Color of the fire in the ring | hex code without # or css color |
currStreakNum | Current streak number | hex code without # or css color |
sideNums | Total and longest streak numbers | hex code without # or css color |
currStreakLabel | Current streak label | hex code without # or css color |
sideLabels | Total and longest streak labels | hex code without # or css color |
dates | Date range text color | hex code without # or css color |
excludeDaysLabel | Excluded days of the week text color | hex code without # or css color |
date_format | Date format pattern or empty for locale format | See note below on 📅 Date Formats |
locale | Locale for labels and numbers (Default: en) | ISO 639-1 code - See 🗪 Locales |
timezone | Timezone used to determine the current day | IANA timezone identifier, eg. Asia/Kolkata |
short_numbers | Use short numbers (e.g. 1.5k instead of 1,500) | true or false |
type | Output format (Default: svg) | Current options: svg, png or json |
mode | Streak mode (Default: daily) | daily (contribute daily) or weekly (contribute once per Sun-Sat week) |
exclude_days | List of days of the week to exclude from streaks | Comma-separated list of day abbreviations (Sun, Mon, Tue, Wed, Thu, Fri, Sat) e.g. Sun,Sat |
disable_animations | Disable SVG animations (Default: false) | true or false |
card_width | Width of the card in pixels (Default: 495) | Positive integer, minimum width is 100px per column |
card_height | Height of the card in pixels (Default: 195) | Positive integer, minimum height is 170px |
hide_total_contributions | Hide the total contributions (Default: false) | true or false |
hide_current_streak | Hide the current streak (Default: false) | true or false |
hide_longest_streak | Hide the longest streak (Default: false) | true or false |
starting_year | Starting year of contributions | Integer, must be 2005 or later, eg. 2017. By default, your account creation year is used. |
🖌 Themes
To enable a theme, append &theme= followed by the theme name to the end of the source URL:
[](https://git.io/streak-stats)
| Theme | Preview |
|---|---|
default |  |
dark |  |
highcontrast |  |
| More themes! | 🎨 See a list of all available themes |
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.
en - English | am - አማርኛ | ar - العربية | as - অসমীয়া | bho - भोजपुरी |
bn - বাংলা | ca - català | ceb - Cebuano | da - dansk | de - Deutsch |
el - Ελληνικά | es - español | et - eesti | fa - فارسی | fi - suomi |
fil - Filipino | fr - français | gu - ગુજરાતી | he - עברית | hi - हिन्दी |
hu - magyar | id - Indonesia | it - italiano | ja - 日本語 | jv - Jawa |
kk - қазақ тілі | kn - ಕನ್ನಡ | ko - 한국어 | mai - मैथिली | mal - മലയാളം |
mi - Māori | mr - मराठी | ms - Melayu | ms_ID - Melayu (Indonesia) | my - မြန်မာ |
ne - नेपाली | nl - Nederlands | no - norsk | pa - ਪੰਜਾਬੀ | pl - polski |
ps - پښتو | pt - português | pt_BR - português (Brasil) | ro - română | ru - русский |
sa - संस्कृत भाषा | sd_PK - سنڌي (پاڪستان) | sr_Cyrl - српски (ћирилица) | sr_Latn - srpski (latinica) | su - Basa Sunda |
sv - svenska | sw - Kiswahili | ta - தமிழ் | tcy - Tulu | te - తెలుగు |
th - ไทย | tr - Türkçe | uk - українська | ur_PK - اردو (پاکستان) | vi - Tiếng Việt |
yo - Èdè Yorùbá | zh_Hans - 中文（简体） | zh_Hant - 中文（繁體） | bg - български | ht - créole haïtien |
hy - հայերեն | rw - Kinyarwanda |
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:
| Date Format | Result |
|---|---|
d F[, Y] | "2020-04-14" => "14 April, 2020" |
j/n/Y | "2020-04-14" => "14/4/2020" |
[Y.]n.j | "2020-04-14" => "2020.4.14" |
M j[, Y] | "2020-04-14" => "Apr 14, 2020" |
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.
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)
📤 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
Instructions for deploying to Vercel (Free)
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
vercelbranch as otherwise you'll get a 404 error from Vercel. You can set thevercelbranch as default after forking the repo.
- Click the Deploy button below
- Create your repository by filling in a Repository Name and clicking "Create"
- Visit this link to create a new Personal Access Token (no scopes required)
- Scroll to the bottom and click "Generate token"
- Add the token as a Config Var with the key
TOKEN:
- Click "Deploy" at the end of the form
- 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
- Sign in to Vercel or create a new account at https://vercel.com
- 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. - Navigate to the cloned repository's directory using the command
cd github-readme-streak-stats - Switch to the "vercel" branch using the command
git checkout vercel - 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.
- Run the command
verceland follow the prompts to link your Vercel account and choose a project name - After successful deployment, your app will be available at
<project-name>.vercel.app - Open this link to create a new Personal Access Token on GitHub. You don't need to select any scopes for the token.
- Scroll to the bottom of the page and click on "Generate token"
- Visit the Vercel dashboard at https://vercel.com/dashboard and select your project. Then, click on "Settings" and choose "Environment Variables".
- Add a new environment variable with the key
TOKENand the value as the token you generated in step 9, then save your changes - (Optional) You can also set the
WHITELISTenvironment 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. - To apply the new environment variable(s), you need to redeploy the app. Run
vercel --prodto 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
vercelas the production branch in the Git settings.
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.
Instructions for deploying to Heroku (Paid)
Step-by-step instructions for deploying to Heroku
- Sign in to Heroku or create a new account at https://heroku.com
- Visit this link to create a new Personal Access Token (no scopes required)
- Scroll to the bottom and click "Generate token"
- Click the Deploy button below
- Add the token as a Config Var with the key
TOKEN:
- (Optional) You can also set the
WHITELISTConfig 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. - Click "Deploy App" at the end of the form
- Once the app is deployed, you can use
<your-app-name>.herokuapp.comin place ofstreak-stats.demolab.com
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.
Instructions for deploying with Docker
Step-by-step instructions for deploying with Docker
-
Clone the repository:
git clone https://github.com/DenverCoder1/github-readme-streak-stats.git cd github-readme-streak-stats -
Visit https://github.com/settings/tokens/new?description=GitHub%20Readme%20Streak%20Stats to create a new Personal Access Token (no scopes required)
-
Scroll to the bottom and click "Generate token"
-
Build the Docker image:
docker build -t streak-stats . -
Run the container with your GitHub token:
docker run -d -p 8080:80 -e TOKEN=your_github_token_here streak-stats -
You can also optionally set the
WHITELISTenvironment variable to restrict which GitHub usernames can be accessed through the service. If theWHITELISTvariable is not set, information can be requested for any GitHub user. Provide the usernames as a comma-separated list, for example:docker run -d -p 8080:80 -e TOKEN=your_github_token_here -e WHITELIST=user1,user2,user3 streak-stats -
Visit http://localhost:8080 to access your self-hosted instance
🤗 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
Repo liên quan
All Algorithms implemented in Python
A curated list of awesome Go frameworks, libraries and software
:octocat: 分享 GitHub 上有趣、入门级的开源项目。Share interesting, entry-level open source projects on GitHub.
Design patterns implemented in Java
Trả lời nhanh
DenverCoder1/github-readme-streak-stats có bao nhiêu sao?
DenverCoder1/github-readme-streak-stats có 7.1k sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/DenverCoder1/github-readme-streak-stats. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
DenverCoder1/github-readme-streak-stats có phải mã nguồn mở không?
Có — DenverCoder1/github-readme-streak-stats phát hành theo license MIT, nghĩa là mã nguồn mở để đọc, fork và (tùy license) tái sử dụng. Mã: github.com/DenverCoder1/github-readme-streak-stats.
DenverCoder1/github-readme-streak-stats còn đang phát triển không?
Commit gần nhất trên DenverCoder1/github-readme-streak-stats là 12 ngày trước (theo timestamp GitHub). Repo có 1.6k fork — một chỉ báo về mức độ quan tâm của cộng đồng.
DenverCoder1/github-readme-streak-stats là gì?
DenverCoder1/github-readme-streak-stats (DenverCoder1/github-readme-streak-stats) là dự án PHP trên GitHub. Theo mô tả gốc: 🔥 Stay motivated and show off your contribution streak! 🌟 Display your total contributions, current streak, and longest streak on your GitHub profile README
DenverCoder1/github-readme-streak-stats so với các dự án Backend khác thế nào?
DenverCoder1/github-readme-streak-stats được TopGit xếp vào nhóm Backend, với 7.1k sao GitHub và viết bằng PHP. Xem trang chủ đề Backend trên TopGit để so sánh với các dự án tương tự theo số sao và mức độ hoạt động.
Đọc thêm về DenverCoder1/github-readme-streak-stats ở đâu?
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/DenverCoder1/github-readme-streak-stats là nguồn chính thức.
Đọc đầy đủ README ở tab phía trên.