Is an easy to use api for generating online custom badges and github profiles summery and repository reports as SVG.
Let's discuss about new ideas:
If you like this project, please buy us a coffee!
- Support for inline query params.
- Support for short inline query params(only required).
- Support for 3 different param splitter(underscore, hyphen, space).
- Add default colors. you can now pass name of color beside hex.
- Add random color generator for badges backgrounds or text colors.
Here is a quick example of how to use the api. For more information, please visit the repo-reporter website or read the docs.
Instead of passing colors as hex you can use our pre-defined default colors names:
repo-reporter.thex.solutions/api/badge/title?title=color&bg=<COLOR_NAME>
names aren't case-sensitive.
Think of a new cool color? Please let us know<3.
For generating random colors you can use the following api with a random param as bg or color :
repo-reporter.thex.solutions/api/badge/title?title=random&bg=random
We strongly recommend you to do not use random colors for badge's text color! Because the random color produced can not match the background color in contrast and make it difficult to see your text in the badge.
Instead of passing the params as query params you can use inline params to just pass a string as design:
repo-reporter.thex.solutions/api/badge/inline/<BADGE>/<SOME_DESIGN>
Or want to pass less params? You can use short inline:
repo-reporter.thex.solutions/api/badge/inline/<BADGE>/<SOME_SHORT_DESIGN>
You can use underscore, hyphen or space as a param splitter.
param1 param2 param3...
param1_param2_param3...
param1-param2-param3...
Please take a look at each badge's examples to see how to inline params.
For generating profile badges you can use the following api with your desired GitHub account id param :
repo-reporter.thex.solutions/api/badge/profile?id=<YOUR-GITHUB-ACCOUNT-ID>
Inline example:
repo-reporter.thex.solutions/api/badge/inline/profile/<THEME>-<YOUR-GITHUB-ACCOUNT-ID>-<BG>-<COLOR>
Short inline example:
repo-reporter.thex.solutions/api/badge/inline/short/profile/<YOUR-GITHUB-ACCOUNT-ID>-<BG>-<COLOR>
For generating link badges you can use the following api with two title and logo params :
repo-reporter.thex.solutions/api/badge/link?title=Hello%20World&logo=globe
Inline example:
repo-reporter.thex.solutions/api/badge/inline/link/<DIRCTION>-<SIZE>-<THEME>-<TITLE>-<LOGO>-<BG>-<COLOR>-<LINK>
Short inline example:
repo-reporter.thex.solutions/api/badge/inline/short/link/<TITLE>-<LOGO>-<BG>-<SIZE>
To make an RTL link badge you must pass a dir parameter:
repo-reporter.thex.solutions/api/badge/link?title=Hello%20World&logo=globe&dir=rtl
! Learn about other params in /docs.
For generating logo badges you can use the following api with a logo param :
repo-reporter.thex.solutions/api/badge/logo?logo=peace
Inline example:
repo-reporter.thex.solutions/api/badge/inline/logo/<SIZE>-<THEME>-<LOGO>-<BG>-<COLOR>-<LINK>
Short inline example:
repo-reporter.thex.solutions/api/badge/inline/short/logo/<LOGO>-<BG>-<SIZE>
! See list of supported logos and icons and learn about other params in /docs.
for generating title badges you can use the following api with a title param :
repo-reporter.thex.solutions/api/badge/title?title=peace
Inline example:
repo-reporter.thex.solutions/api/badge/inline/title/<SIZE>-<THEME>-<TITLE>-<BG>-<COLOR>-<LINK>
Short inline example:
repo-reporter.thex.solutions/api/badge/inline/short/title/<TITLE>-<BG>-<SIZE>
! Learn about other params in /docs.
repo-reporter is developed by Soroush Shemshadi and contributors.
If you want to contribute on this project, Please read the contribution guide.
To see the changes in different versions of repo-reporter, you can read the release notes.
If you encounter a bug or vulnerability, please read the issue policy.
To learn how to work with repo-reporter, please take a look at the /docs folder.
A great thanks to @sarahrajabi for designing the logo.
Made with and
.