base on A tool to generate your github summary card for profile README <div align="center"> <h1>GitHub Profile Summary Cards</h1> [繁體中文](./docs/README.zh-tw.md) <p> A tool to generate your github summary card for profile README. Inspired by <a href=https://github.com/tipsy/profile-summary-for-github>profile-summary-for-github</a> </p> <p> :star: This repo is just for fun, feel free to contribute! :star: </p> <p align="center"> <a href="https://github.com/vn7n24fzkq/github-profile-summary-cards/stargazers"> <img alt="Stargazers" src="https://img.shields.io/github/stars/vn7n24fzkq/github-profile-summary-cards?style=for-the-badge&logo=github&color=f4dbd6&logoColor=D9E0EE&labelColor=302D41"></a> <a href="https://github.com/vn7n24fzkq/github-profile-summary-cards/releases/latest"> <img alt="Releases" src="https://img.shields.io/github/release/vn7n24fzkq/github-profile-summary-cards.svg?style=for-the-badge&logo=semantic-release&color=f5bde6&logoColor=D9E0EE&labelColor=302D41"/></a> <a href="https://www.conventionalcommits.org/en/v1.0.0/"> <img alt="conventionalcommits" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?style=for-the-badge&logo=conventionalcommits&color=ee99a0&logoColor=D9E0EE&labelColor=302D41"></a> <a href="https://github.com/vn7n24fzkq/github-profile-summary-cards/actions/workflows/github-action.yml"> <img alt="testandlint" src="https://img.shields.io/github/actions/workflow/status/vn7n24fzkq/github-profile-summary-cards/test-and-lint.yml?branch=main&label=Test%20and%20Lint&style=for-the-badge&color=a6da95"></a> </p> </div> <div align="center"> <p> <a href="https://github-profile-summary-cards.vercel.app/demo.html">Get your own cards now!!</a> </p>      </div> ## 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) ", Assign "at most 3 tags" to the expected json: {"id":"5795","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"