https://github.com/kerolloz/aktive
Most active GitHub user badge generator
https://github.com/kerolloz/aktive
active-github-user active-user badge deta fastify readme
Last synced: 3 months ago
JSON representation
Most active GitHub user badge generator
- Host: GitHub
- URL: https://github.com/kerolloz/aktive
- Owner: kerolloz
- Created: 2022-10-25T19:28:33.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-14T09:57:33.000Z (8 months ago)
- Last Synced: 2024-11-14T10:36:34.764Z (8 months ago)
- Topics: active-github-user, active-user, badge, deta, fastify, readme
- Language: TypeScript
- Homepage: https://aktive.kerolloz.dev
- Size: 178 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Aktive 🟩
Aktive is a simple web service. It returns a badge (or JSON) that shows your rank among other GitHub users from your country according to your GitHub contributions.
> **Note**
>
> Aktive depends on the data provided by [ashkulz/committers.top](//github.com/ashkulz/committers.top).
> So please make sure that your name appears on your country list here [committers.top](https://committers.top).
## Docs
> [!NOTE]
> You can also check the Swagger [API documentation](https://aktive.kerolloz.dev/swagger) for more details.
### Endpoints
> Base URL:
#### GET `/`
Redirects to this repository.
---
#### GET `/:country/:username`
- Returns a [shields.io](https://shields.io) badge (SVG image) with your rank.
##### Parameters
- `country` - The country you live in (make sure it's visible on your profile).
- `username` - Your GitHub username.
##### Query Parameters
- `style` - Set the style of the badge. Can be one of `flat`, `flat-square`, `for-the-badge`, or `plastic`. Defaults to `flat`.
- `label` - Set the left-hand-side text. Defaults to `Most Active GitHub User Rank`.
- `color` - Set the background of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). Defaults to `brightgreen`.
- `labelColor` - Set the background of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). Defaults to `grey`.
- `rnkPrefix` - Set prefix to display before the rank value. Defaults to `""` empty string.
- `rnkSuffix` - Set suffix to display after the rank value. Defaults to `""` empty string.
##### Examples
> ``
> 
> ``
> 
> ``
> 
> ``
> 
---
#### GET `/rank/:country/:username`
- Returns a JSON object with your rank.
**Same parameters** as [GET `/:country/:username`](#get-countryusername)
##### Example
```bash
$ curl https://aktive.kerolloz.dev/rank/egypt/kerolloz
{
"rank": "109th"
}
```