https://github.com/typicalam/gogoat
Goatcounter TUI viewer
https://github.com/typicalam/gogoat
goatcounter tui
Last synced: 12 months ago
JSON representation
Goatcounter TUI viewer
- Host: GitHub
- URL: https://github.com/typicalam/gogoat
- Owner: TypicalAM
- Created: 2023-05-26T23:07:03.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-07T11:16:48.000Z (over 2 years ago)
- Last Synced: 2025-02-15T05:29:14.482Z (about 1 year ago)
- Topics: goatcounter, tui
- Language: Go
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gogoat
A terminal user interface (TUI) way to view stats from the [goatcounter](https://www.goatcounter.com/) website. It provides a fast and easy way to check-up on your running website stats.
## What's goatcounter
GoatCounter is a lightweight web analytics platform that provides insights into website traffic while respecting user privacy. It distinguishes itself by its simplicity and focus on privacy, avoiding the use of cookies and not collecting personal data. GoatCounter offers essential tracking features, such as page views, referrers, and popular pages, through an intuitive and clean interface. It's particularly suitable for individuals and small businesses looking for a privacy-conscious way to understand their website's performance without compromising on user data security.
## How to use
First, you have to set up the goatcounter dashboard and have two things ready:
1. Site `prefix` - for example if your goatcounter site is `stats.goatcounter.com` the prefix is `stats`
2. The API token
Both of those should be put in an `.env` file in the proect directory:
```env
TOKEN="tokentokentokentokentokentokentokentokentokentoken"
SITE_PREFIX="stats"
```
Then you can run `go run main.go` and get basic page hits. Consult the `client/data.go` file for details.