Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/2ykwang/solvedac-readme-badge

백준 solvec.ac 사용자의 프로필 카드, 뱃지를 생성합니다
https://github.com/2ykwang/solvedac-readme-badge

baekjoon flask github python readme-badges readme-card solved-ac

Last synced: 4 months ago
JSON representation

백준 solvec.ac 사용자의 프로필 카드, 뱃지를 생성합니다

Host: GitHub
URL: https://github.com/2ykwang/solvedac-readme-badge
Owner: 2ykwang
Created: 2021-11-02T07:23:19.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2021-12-04T13:29:08.000Z (about 3 years ago)
Last Synced: 2023-03-04T04:25:39.941Z (almost 2 years ago)
Topics: baekjoon, flask, github, python, readme-badges, readme-card, solved-ac
Language: Python
Homepage:
Size: 281 KB
Stars: 14
Watchers: 1
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        


    solvedac-readme-badge  

   solved.ac 유저 정보를 이용해 README.md에 사용 가능한 뱃지 또는 카드를 만들어주는 프로젝트 입니다.

   




  뱃지 생성하기





 

## TOC

- [TOC](#toc)

- [사용법](#사용법)

- [설치](#설치)

- [뱃지](#뱃지)

  - [설정 가능한 변수](#설정-가능한-변수)

    - [모양](#모양)

    - [테마](#테마)

    - [사이즈](#사이즈)




## 사용법

`user=` 값에 사용자의 solvedac 계정을 입력하여 사용합니다.

- Badge

```md

[![solvedac badge](https://solvedac-readme-badge.vercel.app/api/v1/badge?user=baekjoon_id_here)](https://github.com/2ykwang/solvedac-readme-badge)

```

- Badge (compact)

```md

[![solvedac badge](https://solvedac-readme-badge.vercel.app/api/v1/badge?user=baekjoon_id_here&compact=1)](https://github.com/2ykwang/solvedac-readme-badge)

```




## 설치

```sh

$ git clone https://github.com/2ykwang/solvedac-readme-badge .

$ poetry install

# make .env

$ touch .env

$ echo API_HOST="solved.ac" >> .env

$ flask run

```




## 뱃지

  

    

      ruby

      diamond

      platinum

    

    

      

      

      

    

    

      gold

      silver

      bronze

    

    

      

      

      

    

  




### 설정 가능한 변수

매개변수를 이용해 뱃지 또는 카드를 사용자 정의할 수 있습니다.

e.g) `badge?user?(parameter)=(value)`

| 매개변수         | 타입      |                          설명                          | 기본 값   |                        값                         |

| :--------------- | :-------- | :----------------------------------------------------: | :-------- | :-----------------------------------------------: |

| `user`           | string    |        solved.ac 에 등록된 아이디를 입력합니다.        | `None`    |               `username`,`2ykwang`                |

| `theme`          | string    |                 색 테마를 설정합니다.                  | `default` |      `테마` 항목 참고 `default`, `dark`, ...      |

| `compact`        | boolean   |                뱃지의 모양을 설정합니다                | `true`    |                 `true` or `false`                 |

| `size`           | string    |             뱃지 또는 카드의 크기 입니다.              | `medium`  | `사이즈` 항목 참고 `small` or `medium` or `large` |

| `back_color`     | hex color |   배경 색을 설정합니다. 기본값은 테마 색을 따릅니다.   | `theme`   |           Hex Color code `333`,`939584`           |

| `use_back_color` | boolean   |             배경색을 사용할지 설정합니다.              | `true`    |                 `true` or `false`                 |

| `common_color`   | hex color | 메인 글씨색을 설정합니다. 기본값은 테마 색을 따릅니다. | `theme`   |           Hex Color code `333`,`efefef`           |

| `sub_color`      | hex color | 보조 글씨색을 설정합니다. 기본값은 테마 색을 따릅니다. | `theme`   |           Hex Color code `333`,`efefef`           |

| `border_color`   | hex color |  테두리 색을 설정합니다. 기본값은 테마 색을 따릅니다.  | `theme`   |           Hex Color code `333`,`efefef`           |

| `use_border`     | boolean   |             테두리를 사용할지 설정합니다.              | `True`    |                 `true` or `false`                 |

| `use_shadow`     | boolean   |             그림자를 사용할지 설정합니다.              | `True`    |                 `true` or `false`                 |




#### 모양

`compact` 파라미터를 사용해 모양을 설정할 수 있습니다.

e.g) `compact=true` or `compact=false`

| 값                | compact                                                                                                   |

| :---------------- | :-------------------------------------------------------------------------------------------------------- |

| `True`            | ![preview](https://solvedac-readme-badge.vercel.app/api/v1/badge?user=leaisrevolution&compact=1&use_shadow=1&) |

| `False` (default) | ![preview](https://solvedac-readme-badge.vercel.app/api/v1/badge?user=jthis&use_shadow=1&compact=0)           |

기본값은 `false` 입니다.




#### 테마

`theme` 파라미터를 사용해 테마를 설정할 수 있습니다.

e.g:) `theme=onedark`, `theme=dark`, ...

  

    

      default

      swift

      dark

    

    

      

      

      

    

    

      onedark

      github-dark

      

    

    

      

      

    

  

 




#### 사이즈

`size` 파라미터를 사용해 사이즈를 설정 할 수 있습니다.

입력 가능한 값은 `small`, `medium`, `large` 입니다.

| 값               | 미리보기                                                                                                                           |

| :--------------- | :--------------------------------------------------------------------------------------------------------------------------------- |

| `small`(default) | ![small](https://solvedac-readme-badge.vercel.app/api/v1/badge?user=kravi&theme=default&compact=1&size=small&use_shadow=1&)   |

| `medium`         | ![medium](https://solvedac-readme-badge.vercel.app/api/v1/badge?user=0000000000&theme=default&compact=1&size=medium&use_shadow=1&) |

| `large`          | ![large](https://solvedac-readme-badge.vercel.app/api/v1/badge?user=hun3555&theme=default&compact=1&size=large&use_shadow=1&)   |

기본값은 `small` 입니다.