https://github.com/hi019/better-view-counter

A README Badge for displaying your repositories views, with an option to filter by unique hits.
https://github.com/hi019/better-view-counter

badge badge-generator counter fiber-framework golang

Last synced: about 1 month ago
JSON representation

A README Badge for displaying your repositories views, with an option to filter by unique hits.

• Host: GitHub
• URL: https://github.com/hi019/better-view-counter
• Owner: hi019
• Created: 2020-09-20T15:40:44.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-12-06T00:19:29.000Z (about 3 years ago)
• Last Synced: 2024-06-20T15:51:38.963Z (6 months ago)
• Topics: badge, badge-generator, counter, fiber-framework, golang
• Language: Go
• Homepage:
• Size: 4.5 MB
• Stars: 10
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![](http://counter.gofiber.io/badge/hi019/better-view-counter)

## Usage

better-view-counter generates a view count badge for your repository's README. It supports a custom label and unique views only. To use it, first download the [latest release](https://github.com/hi019/better-view-counter/releases). And then embed the svg like this: `![](https://yourdomain.com/badge/YOUR_USERNAME/YOUR_REPO)`

## Why another view counter?

When assessing other view conuters, we found they were capped at a limited number of requests per hour before the badge returned an error. This is not ideal for high-traffic repositories. Through [Fiber](https://gofiber.io), *better-view-counter* can handle about 30-40k requests per second with no cap on a 1 core vps. Memory usage also stays under 25mb during benchmarks.

## Building 

To build,

1. Clone project, cd into directory

2. `go build`

3. Result will be `./viewcounter`

## Benchmarks

On a 1 core VPS:

```

./bombardier -c 750 -n 1000000 http://127.0.0.1:3000/badge/demo/demo

Statistics        Avg      Stdev        Max

  Reqs/sec     38462.53    4243.36   47245.98

  Latency       19.50ms   105.75ms      7.57s

  HTTP codes:

    1xx - 0, 2xx - 1000000, 3xx - 0, 4xx - 0, 5xx - 0

    others - 0

  Throughput:    52.80MB/s

```

Memory usage under 25mb.