Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kerolloz/kounter
Kounter is a tiny webservice that works as a counter 🧮
https://github.com/kerolloz/kounter
counter-api deta fastify github github-counter github-profile github-profile-counter nodejs profile-views views-count views-counter visitor-counter
Last synced: 3 months ago
JSON representation
Kounter is a tiny webservice that works as a counter 🧮
- Host: GitHub
- URL: https://github.com/kerolloz/kounter
- Owner: kerolloz
- Created: 2022-10-25T08:34:45.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-31T09:34:00.000Z (8 months ago)
- Last Synced: 2024-07-29T17:54:25.233Z (6 months ago)
- Topics: counter-api, deta, fastify, github, github-counter, github-profile, github-profile-counter, nodejs, profile-views, views-count, views-counter, visitor-counter
- Language: TypeScript
- Homepage: https://kounter.kerolloz.dev
- Size: 224 KB
- Stars: 18
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Kounter 🧮
Kounter is a simple counter service that can be used in various ways.
Use cases include a profile views counter, repository visits counter, or anything you want to count.
## Development
For development, you must set the `DETA_PROJECT_KEY` environment variable to your Deta project key.
This project uses [Bun](bun.sh) for development.
```bash
bun dev
```
## Docs
Kounter is built using _Fastify_.
It has a straightforward API with the following few endpoints.
> [!NOTE]
> You can also check the Swagger [API documentation](https://kounter.kerolloz.dev/swagger) for more details.
### Endpoints
> Base URL:
#### GET `/`
Redirects to this repository.
---
#### GET `/badge/:key`
- Increments the counter by 1 if `:key` exits; creates a new counter with count initialized to 1 otherwise.
- Returns a [shields.io](https://shields.io) badge (SVG image) for your counter.
##### Parameters
- `key` - The key of the counter to increment.
##### Query Parameters
- `silent` - Set to `true` to **disable incrementing** the counter. Defaults to `false`.
- `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 `:key`.
- `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`.
- `cntPrefix` - Set prefix to display before the counter value. Defaults to `""` empty string.
- `cntSuffix` - Set suffix to display after the counter value. Defaults to `""` empty string.
##### Examples
> ``
> 
> ``
> 
> ``
> 
> ``
> 
---
#### GET `/count/:key`
- Returns the current count for `:key` **without incrementing** it.
- Returns `{ key: ":key", count: 0 }` if the counter `:key` does not exist.
##### Parameters
- `key` - The key of the counter to get count value for.
##### Example
```bash
$ curl -X GET https://kounter.kerolloz.dev/count/xyz
{
"count": 1,
"key": "xyz"
}
```