{"id":13485210,"url":"https://github.com/vn7n24fzkq/github-profile-summary-cards","last_synced_at":"2025-05-14T05:10:56.097Z","repository":{"id":37000735,"uuid":"292074617","full_name":"vn7n24fzkq/github-profile-summary-cards","owner":"vn7n24fzkq","description":"A tool to generate your GitHub summary card for profile README","archived":false,"fork":false,"pushed_at":"2025-03-28T12:10:18.000Z","size":22108,"stargazers_count":2927,"open_issues_count":30,"forks_count":357,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-05-09T07:41:46.915Z","etag":null,"topics":["github-action","github-profile-readme","hacktoberfest","profile-readme","profile-summary","readme-stats","star","summary-cards","trigger-action"],"latest_commit_sha":null,"homepage":"https://github-profile-summary-cards.vercel.app/demo","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/vn7n24fzkq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2020-09-01T18:19:20.000Z","updated_at":"2025-05-08T23:11:13.000Z","dependencies_parsed_at":"2024-05-12T15:46:19.754Z","dependency_job_id":"917de59c-08d1-4fc7-9fd8-046b2088bb2d","html_url":"https://github.com/vn7n24fzkq/github-profile-summary-cards","commit_stats":{"total_commits":288,"total_committers":27,"mean_commits":"10.666666666666666","dds":0.1875,"last_synced_commit":"a6b65d1c624e194e1abcae04c36a4b82dbea1efe"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vn7n24fzkq%2Fgithub-profile-summary-cards","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vn7n24fzkq%2Fgithub-profile-summary-cards/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vn7n24fzkq%2Fgithub-profile-summary-cards/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vn7n24fzkq%2Fgithub-profile-summary-cards/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vn7n24fzkq","download_url":"https://codeload.github.com/vn7n24fzkq/github-profile-summary-cards/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254076850,"owners_count":22010611,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["github-action","github-profile-readme","hacktoberfest","profile-readme","profile-summary","readme-stats","star","summary-cards","trigger-action"],"created_at":"2024-07-31T17:01:51.051Z","updated_at":"2025-05-14T05:10:51.074Z","avatar_url":"https://github.com/vn7n24fzkq.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","🛠️ Widgets 👇","GitHub Stats","Оформление профиля на GitHub"],"sub_categories":["Dynamic Badges"],"readme":"\u003cdiv align=\"center\"\u003e\n   \u003ch1\u003eGitHub Profile Summary Cards\u003c/h1\u003e\n\n\n   [繁體中文](./docs/README.zh-tw.md)\n   \u003cp\u003e\n      A tool to generate your github summary card for profile README. Inspired by \u003ca href=https://github.com/tipsy/profile-summary-for-github\u003eprofile-summary-for-github\u003c/a\u003e\n   \u003c/p\u003e\n   \u003cp\u003e\n      :star: This repo is just for fun, feel free to contribute! :star:\n   \u003c/p\u003e\n   \u003cp align=\"center\"\u003e\n      \u003ca href=\"https://github.com/vn7n24fzkq/github-profile-summary-cards/stargazers\"\u003e\n      \u003cimg alt=\"Stargazers\" src=\"https://img.shields.io/github/stars/vn7n24fzkq/github-profile-summary-cards?style=for-the-badge\u0026logo=github\u0026color=f4dbd6\u0026logoColor=D9E0EE\u0026labelColor=302D41\"\u003e\u003c/a\u003e\n      \u003ca href=\"https://github.com/vn7n24fzkq/github-profile-summary-cards/releases/latest\"\u003e\n      \u003cimg alt=\"Releases\" src=\"https://img.shields.io/github/release/vn7n24fzkq/github-profile-summary-cards.svg?style=for-the-badge\u0026logo=semantic-release\u0026color=f5bde6\u0026logoColor=D9E0EE\u0026labelColor=302D41\"/\u003e\u003c/a\u003e\n      \u003ca href=\"https://www.conventionalcommits.org/en/v1.0.0/\"\u003e\n      \u003cimg alt=\"conventionalcommits\" src=\"https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?style=for-the-badge\u0026logo=conventionalcommits\u0026color=ee99a0\u0026logoColor=D9E0EE\u0026labelColor=302D41\"\u003e\u003c/a\u003e\n      \u003ca href=\"https://github.com/vn7n24fzkq/github-profile-summary-cards/actions/workflows/github-action.yml\"\u003e\n      \u003cimg alt=\"testandlint\" src=\"https://img.shields.io/github/actions/workflow/status/vn7n24fzkq/github-profile-summary-cards/test-and-lint.yml?branch=main\u0026label=Test%20and%20Lint\u0026style=for-the-badge\u0026color=a6da95\"\u003e\u003c/a\u003e\n   \u003c/p\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\u003cp\u003e\n\u003ca href=\"https://github-profile-summary-cards.vercel.app/demo.html\"\u003eGet your own cards now!!\u003c/a\u003e\n\u003c/p\u003e\n\n\n![](https://raw.githubusercontent.com/vn7n24fzkq/vn7n24fzkq/master/profile-summary-card-output/solarized/0-profile-details.svg)\n![](https://raw.githubusercontent.com/vn7n24fzkq/vn7n24fzkq/master/profile-summary-card-output/solarized/1-repos-per-language.svg)\n![](https://raw.githubusercontent.com/vn7n24fzkq/vn7n24fzkq/master/profile-summary-card-output/solarized/2-most-commit-language.svg)\n![](https://raw.githubusercontent.com/vn7n24fzkq/vn7n24fzkq/master/profile-summary-card-output/solarized/3-stats.svg)\n![](https://raw.githubusercontent.com/vn7n24fzkq/vn7n24fzkq/master/profile-summary-card-output/solarized/4-productive-time.svg)\n\n\u003c/div\u003e\n\n## Themes\n\n|   |   |   |   |   |\n|:---:|:---:|:---:|:---:|:---:|\n|default|2077|dracula|github|github_dark|\n|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=default)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=2077)| ![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=dracula)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=github)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=github_dark)|\n|gruvbox|monokai|nord_bright|nord_dark|radical|\n|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=gruvbox)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=monokai)| ![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=nord_bright)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=nord_dark)  |![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=radical)|\n|solarized|solarized_dark|tokyonight|vue|zenburn|\n|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=solarized)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=solarized_dark)| ![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=tokyonight)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=vue)  |![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=zenburn)|\n|transparent|\n|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=transparent)|\n\n[More themes](https://github.com/vn7n24fzkq/github-profile-summary-cards-example/tree/master/profile-summary-card-output)\n\n## How to use (API)\n### Profile details card\n![](http://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq\u0026theme=nord_bright)\n\n`http://github-profile-summary-cards.vercel.app/api/cards/profile-details?username={username}\u0026theme={theme_name}`\n- Accept url parameters\n  - theme\n    - Theme name\n  - username\n    - Username\n### Top languages used in repository card\n![](http://github-profile-summary-cards.vercel.app/api/cards/repos-per-language?username=vn7n24fzkq\u0026theme=nord_bright)\n\n`http://github-profile-summary-cards.vercel.app/api/cards/repos-per-language?username={username}\u0026theme={theme_name}\u0026exclude={exclude}`\n- Accept url parameters\n  - theme\n    - Theme name\n  - username\n    - Username\n  - exclude:\n    - A comma separated list of languages to exclude, e.g., exclude=java,rust,jupyter%20Notebook\n      - You can represent a space in the language list by using '%20' when you want to include a space.\n    - You can found the supported languages in [here](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)\n\n### Top languages in commits card\n![](http://github-profile-summary-cards.vercel.app/api/cards/most-commit-language?username=vn7n24fzkq\u0026theme=nord_bright)\n\n`http://github-profile-summary-cards.vercel.app/api/cards/most-commit-language?username={username}\u0026theme={theme_name}\u0026exclude={exclude}`\n- Accept url parameters\n  - theme\n    - Theme name\n  - username\n    - Username\n  - exclude:\n    - A comma separated list of languages to exclude, e.g., exclude=java,rust,jupyter%20Notebook\n      - You can represent a space in the language list by using '%20' when you want to include a space.\n    - You can found the supported languages in [here](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)\n\n### GitHub stats card\n![](http://github-profile-summary-cards.vercel.app/api/cards/stats?username=vn7n24fzkq\u0026theme=nord_bright\u0026)\n\n`http://github-profile-summary-cards.vercel.app/api/cards/stats?username={username}\u0026theme={theme_name}`\n- Accept url parameters\n  - theme\n    - Theme name\n  - username\n    - Username\n\n### Productive time card\n![](http://github-profile-summary-cards.vercel.app/api/cards/productive-time?username=vn7n24fzkq\u0026theme=nord_bright\u0026utcOffset=8)\n\n`http://github-profile-summary-cards.vercel.app/api/cards/productive-time?username={username}\u0026theme={theme_name}\u0026utcOffset={utcOffset}`\n- accept url parameters\n  - theme\n  - username\n  - utcOffset\n\n---\n\n## How to use (GitHub Actions)\n\nThis action generate your github profile summary cards and make a commit to your repo.\nYou can also trigger action by yourself after add this action.\n\n:star: [Follow tutorial](https://github.com/vn7n24fzkq/github-profile-summary-cards/wiki/Tutorial) ( Recommendation ) :star:\n\n#### First step\n\n- You need create a [Personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) with correct permissions.\n  [Personal token](https://github.com/vn7n24fzkq/github-profile-summary-cards/wiki/Tutorial#generate-token)\n\n- Add personal access token to repo secret.\n\n#### Use template ( create a repository )\n\n- [github-profile-summary-cards-example](https://github.com/vn7n24fzkq/github-profile-summary-cards-example)\n\n- Action already setup in this template, you just need click `use this template button` to create your profile readme.\n\n- After replace GITHUB_TOKEN with your repo secret and trigger action you can use everything in `profile-summary-card-output` folder.\n\n#### Add to exist repository\n\n- Add this action to repo and replace GITHUB_TOKEN in action yml file with your repo secret.\n\n---\n\n## GitHub Actions usage\n\nAfter the action finished. You can see all of summary cards are in folder which named `profile-summary-card-output`.\n\n`Note: Some summary cards might not be updated in time, because github raw file has cache time.`\n\n```yml\nname: GitHub-Profile-Summary-Cards\n\non:\n  schedule: # execute every 24 hours\n    - cron: \"* */24 * * *\"\n  workflow_dispatch:\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    name: generate-github-profile-summary-cards\n    permissions:\n      contents: write\n\n    steps:\n      - uses: actions/checkout@v4\n      - uses: vn7n24fzkq/github-profile-summary-cards@release\n        env: # default use ${{ secrets.SUMMARY_GITHUB_TOKEN }}, you should replace with your personal access token\n          GITHUB_TOKEN: ${{ secrets.SUMMARY_GITHUB_TOKEN }}\n        with:\n          USERNAME: ${{ github.repository_owner }}\n          # BRANCH_NAME is optional, default to main, branch name to push cards\n          BRANCH_NAME: \"main\"\n          # UTC_OFFSET is optional, default to zero\n          UTC_OFFSET: 8\n          # EXCLUDE is an optional comma seperated list of languages to exclude, defaults to \"\"\n          EXCLUDE: \"\"\n          # AUTO_PUSH is optional, a boolean variable default to true, whether automatically push generated files to desired branch\n          AUTO_PUSH: true\n```\n\n---\n\n## Local Run\n\n- Require `node 16`, lower versions should get some problems.\n- Add personal access token to `.env` file. ex: `GITHUB_TOKEN=abcda69ddf66ae95538c5b1666591b59b4abc73a`\n- Remember `npm run build` after modifying any code\n\n```sh\nnpm run run [username] [UTC offset]\n```\n\nExample\n\n```sh\nnpm run run vn7n24fzkq 8\n```\n\n- To locally run the API you can use the vercel dev package\n\n```sh\nvercel dev\n```\n\n## Deploy your own API on Vercel\nQuickly deploy your own version!\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvn7n24fzkq%2Fgithub-profile-summary-cards\u0026env=GITHUB_TOKEN\u0026envDescription=https%3A%2F%2Fgithub.com%2Fvn7n24fzkq%2Fgithub-profile-summary-cards%23first-step\u0026project-name=my-github-profile-summary-cards)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvn7n24fzkq%2Fgithub-profile-summary-cards","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvn7n24fzkq%2Fgithub-profile-summary-cards","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvn7n24fzkq%2Fgithub-profile-summary-cards/lists"}