Quick Start | StatusBeam

This gets a StatusBeam page running on your machine. To publish it to the edge, follow Deploy to Cloudflare afterwards.

Prerequisites

mise (manages the pinned Node + Bun toolchain)
A Cloudflare account (only needed when you deploy)

Steps

Clone the repository.

git clone https://github.com/pleaseai/statusbeam.git
cd statusbeam

Install the toolchain and dependencies.
```
mise trust && mise install
bun install
```
Create your config. Copy the example and edit the services you want to monitor (see Configuration).
```
cp status.config.example.yml status.config.yml
```
Run the dev servers.
```
bun run dev
```
This starts the Turborepo dev pipeline — the Astro status page and the check Worker in watch mode.

What’s next

Your page renders from local data. When you’re ready to publish, provision D1 + KV and deploy the Worker and site to Cloudflare — see Deploy to Cloudflare.