🏆 Add dynamically generated GitHub Trophy on your readme
# Quick Start Add following code to your readme. Change the `?username=` value to your GitHub's username. ``` [](https://github.com/ryo-ma/github-profile-trophy) ```
There are still few secret trophies.
Therefore, if you come up with interesting conditions, 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. Next Rank Bar. The road from the current rank to the next rank.
# Optional Request Parameters
* [title](#filter-by-titles)
* [rank](#filter-by-ranks)
* [column](#specify-the-maximum-row--column-size)
* [row](#specify-the-maximum-row--column-size)
## Filter by titles
You can filter the display by specifying the titles of trophy.
```
https://github-profile-trophy.vercel.app/?username=ryo-ma&title=Follower
```
If You want to specify multiple titles.
```
https://github-profile-trophy.vercel.app/?username=ryo-ma&title=Star,Follower
```
## Filter by ranks
You can filter the display by specifying the ranks.
`Available values: SECRET SSS SS S AAA AA A B C`
```
https://github-profile-trophy.vercel.app/?username=ryo-ma&rank=S
```
If You want to specify multiple ranks.
```
https://github-profile-trophy.vercel.app/?username=ryo-ma&rank=S,AAA
```
## Specify the maximum row & column size
You can specify the maximum row and column size.
Trophy out of limits will not be displayed.
`Available value: number type`
`Default: column=6 row=3`
Restrict only row
```
https://github-profile-trophy.vercel.app/?username=ryo-ma&row=2
```
Restrict only column
```
https://github-profile-trophy.vercel.app/?username=ryo-ma&column=2
```
Restrict row & column
```
https://github-profile-trophy.vercel.app/?username=ryo-ma&row=2&column=3
```
# Contribution Guide
## Environment
* Deno >= v1.3.0
* typescript == 3.9.7
* [Vercel](https://vercel.com/)
* GitHub API v4
## Local Run
Create `.env` file to project root directory, and write your GitHub token to the `.env` file.
```
GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
Run local server.
```
deno run --allow-net --allow-read --allow-env debug.ts
```
Open localhost from your browser.
http://localhost:8080/?username=ryo-ma
## Editor config
Read the [.editorconfig](./.editorconfig)
## Run deno lint
If you want to contribute to my project, you should check the lint with the following command.
```
deno lint --unstable
```