kounter

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #llm #android #linux #macos #nodejs #windows #cli #awesome-list #vue #ios

(★ 20)

Kounter is a tiny webservice that works as a counter 🧮

kounter Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="left">Kounter 🧮
  <a target="_blank" href="https://fastify.io">
    <img alt="fastify" align="right" src="https://img.shields.io/static/v1?logo=fastify&label=&message=Fastify&style=for-the-badge&color=grey"/>
  </a>
  <a target="_blank" href="https://railway.app/">
    <img alt="Railway" align="right" src="https://img.shields.io/static/v1?label=&message=Railway&style=for-the-badge&color=grey&logo=railway" />
  </a>
</h1>

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 `DATABASE_URL` environment variable to your MongoDB connection string (see `.env.example`).  
This project uses [Bun](https://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: <https://kounter.kerolloz.dev>

#### 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

> `![badge](https://kounter.kerolloz.dev/badge/kerolloz.kounter)`  
> ![badge](https://kounter.kerolloz.dev/badge/kerolloz.kounter)

> `![badge](https://kounter.kerolloz.dev/badge/kerolloz.kounter?style=flat-square&color=blue&silent=true)`  
> ![badge](https://kounter.kerolloz.dev/badge/kerolloz.kounter?style=flat-square&color=blue&silent=true)

> `![badge](https://kounter.kerolloz.dev/badge/kerolloz.kounter?label=kerolloz/kounter&labelColor=white&cntPrefix=visits%20&silent=true)`  
> ![badge](https://kounter.kerolloz.dev/badge/kerolloz.kounter?label=kerolloz/kounter&labelColor=white&cntPrefix=visits%20&silent=true)

> `![badge](https://kounter.kerolloz.dev/badge/kerolloz.kounter?label=&color=333&style=for-the-badge&cntSuffix=%20Views&silent=true)`  
> ![badge](https://kounter.kerolloz.dev/badge/kerolloz.kounter?label=&color=333&style=for-the-badge&cntSuffix=%20Views&silent=true)

---

#### 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"
}
```

kounter

kounter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

kounter

kounter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README