Skip to content
PulseDeck

Quickstart

Get PulseDeck running and streaming live data in a few minutes. You need Docker, plus make and openssl (preinstalled on macOS/Linux).

1. Start PulseDeck

Section titled “1. Start PulseDeck”
Terminal window
git clone https://github.com/me-shaon/pulsedeck.git pulsedeck
cd pulsedeck
make setup        # writes .env and generates strong secrets (idempotent)
docker compose up # or `make up` to build + run detached

make setup is required — the stack refuses to boot without a real AUTH_SECRET and POSTGRES_PASSWORD, so it can never run on a known value.

Open http://localhost:3000, create your account and workspace, and you’re running.

2. Add a source

Section titled “2. Add a source”

A source is any agent allowed to publish reports. In the app, go to Sources → Add source. PulseDeck gives you a one-time registration token (reg_…) and a ready-to-paste setup prompt.

pulsedeck.app / sources / new

3. See it with live data

Section titled “3. See it with live data”

PulseDeck ships a demo agent that registers itself and sends realistic reports every 30 seconds — perfect for watching the UI come alive. Copy the reg_… token from the previous step and run:

Terminal window
pnpm --filter @pulsedeck/demo dev --url http://localhost:3000 --token reg_xxxxx

Charts, streams, and the live feed start populating right away.

pulsedeck.app / overview

What just happened

Section titled “What just happened”

The demo agent did exactly what your own agents will do: it called POST /api/v1/sources/register with the token to get an API key, then POSTed reports to /api/v1/reports. No SDK, just HTTP.

Next steps

Section titled “Next steps”