https://github.com/summersec/github-profile-cards
https://github.com/summersec/github-profile-cards
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/summersec/github-profile-cards
- Owner: SummerSec
- License: mit
- Created: 2022-10-19T11:28:58.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-20T02:08:14.000Z (about 3 years ago)
- Last Synced: 2025-01-21T11:44:35.366Z (12 months ago)
- Language: TypeScript
- Size: 5.63 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
GitHub Profile Summary Cards
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:
[繁體中文](./docs/README.zh-tw.md)
---
## Sponsors
![]()
Foresight: Increase CI/CD Health & Test Performance
Foresight provides full visibility and deep insights into the health
and performance of your tests and CI/CD pipelines. Assess the risk of
changes, resolve bottlenecks, reduce build times, and deliver
high-quality software at speed with Foresight.
[Sign up now!](https://runforesight.com/?utm_source=github-profile-summary-cards&utm_medium=sponsorship)
---
## Themes
| | | | | |
|:---:|:---:|:---:|:---:|:---:|
|default|2077|dracula|github|github_dark|
||| |||
|gruvbox|monokai|nord_bright|nord_dark|radical|
||| | ||
|solarized|solarized_dark|tokyonight|vue|zenburn|
||| | ||
[More themes](https://github.com/vn7n24fzkq/github-profile-summary-cards-example/tree/master/profile-summary-card-output)
---
## 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/Toturial) ( 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 permissions](https://github.com/vn7n24fzkq/github-profile-summary-cards/wiki/Personal-access-token-permissions)
- 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
steps:
- uses: actions/checkout@v2
- 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 }}
# UTC_OFFSET is optional, default to zero
UTC_OFFSET: 8
```
---
## 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
```
## 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)