CONTRIBUTING

Contribution Guide

Environment

- Deno >= v1.36.1
- Vercel
- GitHub API v4
- Docker and Docker compose (optional)

Local Run

Create .env file to project root directory, and write your GitHub token to the
.env file. Please select the authority of repo when creating token.

properties

GITHUB_TOKEN1=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
GITHUB_TOKEN2=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
if using GitHub Enterprise:

(this env var defaults to https://api.github.com/graphql)

GITHUB_API=https://github.example.com/api/graphql

Run local server.

deno task start

You can enable the Redis if you want, but it's not mandatory.

docker compose up -d

Rename env-example to .env, and change ENABLE_REDIS to true

Open localhost from your browser.

http://localhost:8080/?username=ryo-ma

Editor config

Read the .editorconfig

Pull Requests

Pull requests are always welcome! In general, they should a single concern in
the least number of changed lines as possible. For changes that address core
functionality, it is best to open an issue to discuss your proposal first. I
look forward to seeing what you come up with!

Run deno lint

What to do before contributing

1. Run deno lint

deno task lint

2. Run deno format

deno task format

3. Run deno test

deno task test

---

README

<div align="center">
<img width="140" src="https://user-images.githubusercontent.com/6661165/91657958-61b4fd00-eb00-11ea-9def-dc7ef5367e34.png" alt="GitHub Profile Trophy"/>
<h2 align="center">GitHub Profile Trophy</h2>
🏆 Add dynamically generated GitHub Stat Trophies on your README
</div>
<div align="center">

[](https://github.com/ryo-ma/github-profile-trophy/stargazers)
[](https://github.com/ryo-ma/github-profile-trophy/network/members)
[](https://github.com/ryo-ma/github-profile-trophy/issues)
[](https://github.com/ryo-ma/github-profile-trophy/blob/master/LICENSE)
[](https://twitter.com/intent/tweet?text=Add%20dynamically%20generated%20GitHub%20Trophy%20on%20your%20readme%0D%0A&url=https%3A%2F%2Fgithub.com%2Fryo-ma%2Fgithub-profile-trophy)

</div>

You can use this service for free. I'm looking for sponsors to help us keep up with this service❤️

<div align="center">
<a href="https://github.com/sponsors/ryo-ma">
<img src="https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=ff69b4" alt="Sponsor"/>
</a>
</div>

⚠️ Notice from the Project Owner

> Hello everyone,\

I am the owner of this project.

> Currently, due to the increase in users and traffic, the cost of maintaining

this service has become quite high, and it is becoming financially difficult

to sustain.\

As costs continue to rise, there is a possibility that the service may have to

be discontinued.\

We are now at a stage where monetization and financial support are essential.

> Your support in the following ways would be greatly appreciated:

> 1. Financial support: GitHub Sponsors

2. Reducing server load through self-hosting (by forking on GitHub and

deploying to Vercel)

3. Share your github-profile-trophy URL deployed to Vercel for load balancing

(Send email: [email protected] or Pull Request)

Load balancing endpoints

These are endpoints provided by volunteers. Please use these in moderation.

Quick Start

Add the following code to your readme. When pasting the code into your profile's
readme, change the ?username= value to your GitHub's username.

text

[](https://github.com/ryo-ma/github-profile-trophy)

Use theme

Add optional parameter of the theme.

text

[](https://github.com/ryo-ma/github-profile-trophy)

More detail

About Rank

Ranks are SSS SS S AAA AA A B C UNKNOWN SECRET.

| Rank | Description |
| ---------- | ------------------------------------------------------------------------------------------ |
| SSS, SS, S | You are at a hard to reach rank. You can brag. |
| AAA, AA, A | You will reach this rank if you do your best. Let's aim here first. |
| B, C | You are currently making good progress. Let's aim a bit higher. |
| UNKNOWN | You have not taken action yet. Let's act first. |
| SECRET | This rank is very rare. The trophy will not be displayed until certain conditions are met. |

NOTE: The UNKNOWN rank is denoted by ?

Secret Rank

The acquisition condition is secret, but you can see this.

There are only a few secret trophies. Therefore, if you come up with interesting
conditions, I will consider adding a trophy. I am waiting for contributions.

About Display details

1. Title name of aggregation target.
2. Current rank.
3. Title according to rank.
4. Target aggregation result.
5. Rank progress bar.

Optional Request Parameters

- title
- rank
- column
- row
- theme
- margin-w
- margin-h
- no-bg
- no-frame

Filter by titles

You can filter the display by specifying the titles of trophy.

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&title=Followers

If you want to specify multiple titles.

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&title=Stars,Followers

You can also exclude the trophies you don't want to display.

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&title=-Stars,-Followers

Filter by ranks

You can filter the display by specifying the ranks.\
Available values: SECRET SSS SS S AAA AA A B C

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&rank=S

If you want to specify multiple ranks.

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&rank=S,AAA

You can also exclude ranks.

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&rank=-C,-B

NOTE: Since UNKNOWN is denoted by ?, in order to include or exclude it you
will have to use rank=? and rank=-? respectively

Specify the maximum row & column size

You can specify the maximum row and column size.\
Trophy will be hidden if it exceeds the range of both row and column.

Available value: number type\
Default: column=6 row=3

Restrict only row

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&row=2

Restrict only column

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&column=2

Restrict row & column

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&row=2&column=3

Adaptive column

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&column=-1

You can set column to -1 to adapt the width to the number of trophies, the
parameter row will be ignored.

Apply theme

Available themes.

| theme |
| --------------------------- |
| flat |
| onedark |
| gruvbox |
| dracula |
| monokai |
| chalk |
| nord |
| alduin |
| darkhub |
| juicyfresh |
| buddhism |
| oldie |
| radical |
| onestar |
| discord |
| algolia |
| gitdimmed |
| tokyonight |
| matrix |
| apprentice |
| dark_dimmed |
| dark_lover |
| kimbie_dark |
| aura |

flat

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=flat

onedark

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=onedark

gruvbox

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=gruvbox

dracula

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=dracula

monokai

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=monokai

chalk

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=chalk

nord

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=nord

alduin

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=alduin

darkhub

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=darkhub

juicyfresh

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=juicyfresh

buddhism

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=buddhism

oldie

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=oldie

radical

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=radical

onestar

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=onestar

discord

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=discord

algolia

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=algolia

gitdimmed

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=gitdimmed

tokyonight

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=tokyonight

matrix

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=matrix

apprentice

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=apprentice

dark_dimmed

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=dark_dimmed

dark_lover

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=dark_lover

kimbie_dark

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=kimbie_dark

aura

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=aura

Margin Width

You can put a margin in the width between trophies.\
Available value: number type\
Default: margin-w=0

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&margin-w=15

Margin Height

You can put a margin in the height between trophies.\
Available value: number type\
Default: margin-h=0

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&margin-h=15

Example layout

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&column=3&margin-w=15&margin-h=15

Transparent background

You can turn the background transparent.\
Available value: boolean type (true or false)\
Default: no-bg=false

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&no-bg=true

Hide frames

You can hide the frames around the trophies.\
Available value: boolean type (true or false)\
Default: no-frame=false

text

https://github-profile-trophy.vercel.app/?username=ryo-ma&no-frame=true

Generate an svg file localy

Using the render_svg.ts script you can generate your trophys as an svg file
given your username, (Enviroment Vars: See env-example).

Usage:

bash

deno run --allow-net --allow-env --allow-read --allow-write ./render_svg.ts USERNAME OUTPUT_DIR THEME

Generate an svg inside Github CI (Workflow)

Using the provided github action you can easly generate the trophy inside an
github workflow. This eliminates the needs of an online service running but you
have to manualy update rerun the action to update the file.

Usage:

yaml

- name: Generate trophy
  uses: Erik-Donath/github-profile-trophy@feature/generate-svg
  with:
    username: your-username
    output_path: trophy.svg
    token: ${{ secrets.GITHUB_TOKEN }}

Self-hosting on Vercel

By self-hosting you avoid rate-limits, instances getting paused and you bypass
the #439 issue.

1. For people who do not have this repo forked, you need to do that before you
can deploy anything.

2. Make an account, connect your GitHub account to Vercel, and import your repo.

3. Go back to GitHub, generate a token, and copy it.

4. Set your token scopes to read:user + public_repo (only use repo if you
want private contributions counted).

5. On Vercel's configure screen, add two environment variables and paste the
token as the value of each — you can use the same token for both:

text

GITHUB_TOKEN1=your_token
GITHUB_TOKEN2=your_token

6. After that you can deploy it.

7. Set Vercel Authentication -> Only Preview Deployments, or your card shows
blank.

8. You get a domain which you can use/test, it looks something like this:

text

https://<your-app>.vercel.app/?username=USERNAME

Contribution Guide

Check CONTRIBUTING.md for more details.

License

This product is licensed under the
MIT License.

🙏 Sponsors

Thank you so much to all the amazing sponsors who support this project! Your
contributions help keep development going and make this work possible.

💖 Monthly Sponsors

- @Leay15 - $10 / month
- @hesreallyhim - $10 / month
- @pmsosa — $10 / month
- @chenfeng-huang — $10 / month
- @holly-hacker — $2 / month
- @skillerious — $2 / month (since Aug
17, 2024)
- @LudovicGardy — $10 / month (since Aug
15, 2024)
- @alexcastrodev — $10 / month (since Oct
13, 2023, previously $50 / month)
- @great-work-told-is — $10 / month
(since Apr 12, 2023)
- @Ilithy — $5 / month (since Jul 21, 2022)
- @weakish — $2 / month (since Jan 22, 2022)
- @Kazuhito00 — $2 / month (since Jan 19, 2022)
- @KATO-Hiro — $2 / month (since Jan 5, 2022)
- @batazor — $2 / month (since Oct 28, 2021)
- @port19x — $2 / month (since Jan 27, 2022)

---

CONTRIBUTING Copy Section

Contribution Guide

Environment Copy Chapter

Local Run Copy Chapter

if using GitHub Enterprise:

(this env var defaults to https://api.github.com/graphql)

Editor config Copy Chapter

Pull Requests Copy Chapter

Run deno lint Copy Chapter

What to do before contributing Copy Chapter

1. Run deno lint Copy Section

2. Run deno format Copy Section

3. Run deno test Copy Section

README Copy Section

Load balancing endpoints

Quick Start

Use theme Copy Chapter

About Rank

Secret Rank Copy Chapter

About Display details

Optional Request Parameters

Filter by titles Copy Chapter

Filter by ranks Copy Chapter

Specify the maximum row & column size Copy Chapter

Apply theme Copy Chapter

flat Copy Section

onedark Copy Section

gruvbox Copy Section

dracula Copy Section

monokai Copy Section

chalk Copy Section

nord Copy Section

alduin Copy Section

darkhub Copy Section

juicyfresh Copy Section

buddhism Copy Section

oldie Copy Section

radical Copy Section

onestar Copy Section

discord Copy Section

algolia Copy Section

gitdimmed Copy Section

tokyonight Copy Section

matrix Copy Section

apprentice Copy Section

dark_dimmed Copy Section

dark_lover Copy Section

kimbie_dark Copy Section

aura Copy Section

Margin Width Copy Chapter

Margin Height Copy Chapter

Example layout Copy Chapter

Transparent background Copy Chapter

Hide frames Copy Chapter

Generate an svg file localy Copy Chapter

Generate an svg inside Github CI (Workflow) Copy Chapter

Self-hosting on Vercel Copy Chapter

Contribution Guide

License

🙏 Sponsors

💖 Monthly Sponsors Copy Chapter

🎁 One-Time Sponsors Copy Chapter

Explore Related Technologies & Topics

CONTRIBUTING

Environment

Local Run

Editor config

Pull Requests

Run deno lint

What to do before contributing

1. Run deno lint

2. Run deno format

3. Run deno test

README

Use theme

Secret Rank

Filter by titles

Filter by ranks

Specify the maximum row & column size

Apply theme

flat

onedark

gruvbox

dracula

monokai

chalk

nord

alduin

darkhub

juicyfresh

buddhism

oldie

radical

onestar

discord

algolia

gitdimmed

tokyonight

matrix

apprentice

dark_dimmed

dark_lover

kimbie_dark

aura

Margin Width

Margin Height

Example layout

Transparent background

Hide frames

Generate an svg file localy

Generate an svg inside Github CI (Workflow)

Self-hosting on Vercel

💖 Monthly Sponsors

🎁 One-Time Sponsors