Repository files navigation

default	2077	dracula	github	github_dark
gruvbox	monokai	nord_bright	nord_dark	radical
solarized	solarized_dark	tokyonight	vue	zenburn
transparent

More themes

http://github-profile-summary-cards.vercel.app/api/cards/profile-details?username={username}&theme={theme_name}

• Accept url parameters
  • theme
    • Theme name
  • username
    • Username

http://github-profile-summary-cards.vercel.app/api/cards/repos-per-language?username={username}&theme={theme_name}&exclude={exclude}

• Accept url parameters
  • theme
    • Theme name
  • username
    • Username
  • exclude:
    • A comma separated list of languages to exclude, e.g., exclude=java,rust,jupyter%20Notebook
      • You can represent a space in the language list by using '%20' when you want to include a space.
    • You can found the supported languages inhere

http://github-profile-summary-cards.vercel.app/api/cards/most-commit-language?username={username}&theme={theme_name}&exclude={exclude}

• Accept url parameters
  • theme
    • Theme name
  • username
    • Username
  • exclude:
    • A comma separated list of languages to exclude, e.g., exclude=java,rust,jupyter%20Notebook
      • You can represent a space in the language list by using '%20' when you want to include a space.
    • You can found the supported languages inhere

http://github-profile-summary-cards.vercel.app/api/cards/stats?username={username}&theme={theme_name}

• Accept url parameters
  • theme
    • Theme name
  • username
    • Username

http://github-profile-summary-cards.vercel.app/api/cards/productive-time?username={username}&theme={theme_name}&utcOffset={utcOffset}

• accept url parameters
  • theme
  • username
  • utcOffset

This action generate your github profile summary cards and make a commit to your repo.You can also trigger action by yourself after add this action.

⭐Follow tutorial ( Recommendation ) ⭐

• You need create aPersonal access token with correct permissions.Personal token

• Add personal access token to repo secret.

• github-profile-summary-cards-example

• Action already setup in this template, you just need clickuse this template button to create your profile readme.

• After replace GITHUB_TOKEN with your repo secret and trigger action you can use everything inprofile-summary-card-output folder.

• Add this action to repo and replace GITHUB_TOKEN in action yml file with your repo secret.

After the action finished. You can see all of summary cards are in folder which namedprofile-summary-card-output.

Note: Some summary cards might not be updated in time, because github raw file has cache time.

name:GitHub-Profile-Summary-Cardson:schedule:# execute every 24 hours    -cron:"* */24 * * *"workflow_dispatch:jobs:build:runs-on:ubuntu-latestname:generate-github-profile-summary-cardspermissions:contents:writesteps:      -uses:actions/checkout@v4      -uses:vn7n24fzkq/github-profile-summary-cards@releaseenv:# default use ${{ secrets.SUMMARY_GITHUB_TOKEN }}, you should replace with your personal access tokenGITHUB_TOKEN:${{ secrets.SUMMARY_GITHUB_TOKEN }}with:USERNAME:${{ github.repository_owner }}# BRANCH_NAME is optional, default to main, branch name to push cardsBRANCH_NAME:"main"# UTC_OFFSET is optional, default to zeroUTC_OFFSET:8# EXCLUDE is an optional comma seperated list of languages to exclude, defaults to ""EXCLUDE:""# AUTO_PUSH is optional, a boolean variable default to true, whether automatically push generated files to desired branchAUTO_PUSH:true

• Requirenode 16, lower versions should get some problems.
• Add personal access token to.env file. ex:GITHUB_TOKEN=abcda69ddf66ae95538c5b1666591b59b4abc73a
• Remembernpm run build after modifying any code

npm run run [username] [UTC offset]

Example

npm run run vn7n24fzkq 8

• To locally run the API you can use the vercel dev package

vercel dev

Quickly deploy your own version!