Skip to content

Getting Started

Generate your first WBR deck in under 10 minutes using the sample files that ship with the app.

Prerequisites

  • Python 3.12+
  • Git

1. Install and run the app

git clone https://github.com/working-backwards/wbr-app.git
cd wbr-app
python -m venv venv
source venv/bin/activate        # Mac/Linux
# venv\Scripts\activate         # Windows
pip install -r requirements.txt
python src/wbr.py

Open http://localhost:5001/wbr.html.

2. Download the sample files

Click the hamburger menu (☰) → Get Reference Samples. Download:

  • 1-wbr-sample-dataset.csv
  • 1-wbr-sample-config.yaml

3. Generate your first deck

Click ☰ → Upload & Generate Report.

  1. Select the sample CSV file
  2. Select the sample YAML config
  3. Click GENERATE REPORT

You should see a WBR deck with 6/12 charts, tables, and summary metrics. See a sample WBR report for an example of the output.

4. Understand the YAML config

Open 1-wbr-sample-config.yaml (view on GitHub). The file has these sections, in order:

YAML Section Purpose Docs
setup Deck metadata — title, week ending date, options setup
data_sources Database queries and CSV file references data_sources
annotations Business events to overlay on charts annotations
metrics Map data columns to named metrics with aggregation rules metrics
deck Define which blocks (charts/tables) to render deck

5. Publish and share

After generating a deck, click the green PUBLISH button in the top-right corner. The app generates a shareable URL.

See Publishing & Export for password protection and JSON export.

Next steps