Skip to content

scalar-dev/beampipe

Repository files navigation

Beampipe

Beampipe is a simple, open source web analytics tool built on TimescaleDB. Try it out at beampipe.io. We are currently working on updating this README and making beampipe easy to self-host.

screenhot

Beampipe is built and sponsored by Scalar.

Running beampipe

If you want to have a quick play with beampipe on your local machine, the simplest way is using docker-compose:

curl https://raw.githubusercontent.com/scalar-dev/beampipe/master/docker-compose.yml -o docker-compose.yml
docker-compose up

This will launch both timescaledb and beampipe. You should be able to access the web UI at http://localhost:8080.

Docker images are available on Docker Hub:

  • server contains both the server and the UI
  • ui is just the UI (served via nginx) e.g. for running in k8s.

Architecture

Beampipe is designed to be simple and easy to deploy anywhere. The backend is written in Kotlin using Micronaut and requires only a PostgreSQL database with the TimescaleDB extension installed.

The frontend is built with TypeScript, React and Tailwind.

Both components can be deployed via kubernetes (docker images and configuration coming soon!).


Website

Start developing

cd web
yarn
yarn dev

Run locally at http://localhost:3000

Docs

Docs website: https://docs.beampipe.io/

Start developing

cd docs
yarn
gatsby develop

Run locally at http://localhost:8000

About

Free simple, web analytics using TimescaleDB

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published