The solvedac-readme-badge from 2ykwang

solvedac-readme-badge

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

뱃지 생성하기

사용법

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

Badge

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

Badge (compact)

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

설치

$ 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`