Skip to content
StatusBeamStatusBeam

Search is only available in production builds. Try building and previewing the site to test it out locally.

Quick Start

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

Prerequisites

Section titled “Prerequisites”
  • mise (manages the pinned Node + Bun toolchain)
  • A Cloudflare account (only needed when you deploy)

Steps

Section titled “Steps”

  1. Clone the repository.

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

  2. Install the toolchain and dependencies.

    Terminal window
    mise trust && mise install
    bun install

  3. Create your config. Copy the example and edit the services you want to monitor (see Configuration).

    Terminal window
    cp status.config.example.yml status.config.yml

  4. Run the dev servers.

    Terminal window
    bun run dev

    This starts the Turborepo dev pipeline — the Astro status page and the check Worker in watch mode.

What’s next

Section titled “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.