Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vn7n24fzkq/github-profile-summary-cards
A tool to generate your github summary card for profile README
https://github.com/vn7n24fzkq/github-profile-summary-cards
github-action github-profile-readme hacktoberfest profile-readme profile-summary readme-stats star summary-cards trigger-action
Last synced: 4 days ago
JSON representation
A tool to generate your github summary card for profile README
- Host: GitHub
- URL: https://github.com/vn7n24fzkq/github-profile-summary-cards
- Owner: vn7n24fzkq
- License: mit
- Created: 2020-09-01T18:19:20.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T15:22:05.000Z (3 months ago)
- Last Synced: 2024-10-29T15:28:07.721Z (2 months ago)
- Topics: github-action, github-profile-readme, hacktoberfest, profile-readme, profile-summary, readme-stats, star, summary-cards, trigger-action
- Language: TypeScript
- Homepage: https://github-profile-summary-cards.vercel.app/demo
- Size: 21 MB
- Stars: 2,638
- Watchers: 16
- Forks: 315
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ccamel - vn7n24fzkq/github-profile-summary-cards - A tool to generate your github summary card for profile README (TypeScript)
- project-awesome - vn7n24fzkq/github-profile-summary-cards - A tool to generate your github summary card for profile README (TypeScript)
- awesome-github-profile - Github Profile Summary Cards
README
GitHub Profile Summary Cards
[繁體中文](./docs/README.zh-tw.md)
A tool to generate your github summary card for profile README. Inspired by profile-summary-for-github
:star: This repo is just for fun, feel free to contribute! :star:
## Themes
| | | | | |
|:---:|:---:|:---:|:---:|:---:|
|default|2077|dracula|github|github_dark|
||| |||
|gruvbox|monokai|nord_bright|nord_dark|radical|
||| | ||
|solarized|solarized_dark|tokyonight|vue|zenburn|
||| | ||
|transparent|
||
[More themes](https://github.com/vn7n24fzkq/github-profile-summary-cards-example/tree/master/profile-summary-card-output)
## How to use (API)
### Profile details card
`http://github-profile-summary-cards.vercel.app/api/cards/profile-details?username={username}&theme={theme_name}`
- Accept url parameters
- theme
- Theme name
- username
- Username
### Top languages used in repository card
`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 in [here](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)
### Top languages in commits card
`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 in [here](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)
### GitHub stats card
`http://github-profile-summary-cards.vercel.app/api/cards/stats?username={username}&theme={theme_name}`
- Accept url parameters
- theme
- Theme name
- username
- Username
### Productive time card
`http://github-profile-summary-cards.vercel.app/api/cards/productive-time?username={username}&theme={theme_name}&utcOffset={utcOffset}`
- accept url parameters
- theme
- username
- utcOffset
---
## How to use (GitHub Actions)
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.
:star: [Follow tutorial](https://github.com/vn7n24fzkq/github-profile-summary-cards/wiki/Tutorial) ( Recommendation ) :star:
#### First step
- You need create a [Personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) with correct permissions.
[Personal token](https://github.com/vn7n24fzkq/github-profile-summary-cards/wiki/Tutorial#generate-token)
- Add personal access token to repo secret.
#### Use template ( create a repository )
- [github-profile-summary-cards-example](https://github.com/vn7n24fzkq/github-profile-summary-cards-example)
- Action already setup in this template, you just need click `use this template button` to create your profile readme.
- After replace GITHUB_TOKEN with your repo secret and trigger action you can use everything in `profile-summary-card-output` folder.
#### Add to exist repository
- Add this action to repo and replace GITHUB_TOKEN in action yml file with your repo secret.
---
## GitHub Actions usage
After the action finished. You can see all of summary cards are in folder which named `profile-summary-card-output`.
`Note: Some summary cards might not be updated in time, because github raw file has cache time.`
```yml
name: GitHub-Profile-Summary-Cards
on:
schedule: # execute every 24 hours
- cron: "* */24 * * *"
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
name: generate-github-profile-summary-cards
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: vn7n24fzkq/github-profile-summary-cards@release
env: # default use ${{ secrets.SUMMARY_GITHUB_TOKEN }}, you should replace with your personal access token
GITHUB_TOKEN: ${{ secrets.SUMMARY_GITHUB_TOKEN }}
with:
USERNAME: ${{ github.repository_owner }}
# BRANCH_NAME is optional, default to main, branch name to push cards
BRANCH_NAME: "main"
# UTC_OFFSET is optional, default to zero
UTC_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 branch
AUTO_PUSH: true
```
---
## Local Run
- Require `node 16`, lower versions should get some problems.
- Add personal access token to `.env` file. ex: `GITHUB_TOKEN=abcda69ddf66ae95538c5b1666591b59b4abc73a`
- Remember `npm run build` after modifying any code
```sh
npm run run [username] [UTC offset]
```
Example
```sh
npm run run vn7n24fzkq 8
```
- To locally run the API you can use the vercel dev package
```sh
vercel dev
```
## Deploy your own API on Vercel
Quickly deploy your own version!
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvn7n24fzkq%2Fgithub-profile-summary-cards&env=GITHUB_TOKEN&envDescription=https%3A%2F%2Fgithub.com%2Fvn7n24fzkq%2Fgithub-profile-summary-cards%23first-step&project-name=my-github-profile-summary-cards)