Skip to content

Quick Start (UI First)

This quickstart is optimized for first success in the web UI. For service-to-service flows, use Integration Quickstart.

Prerequisites

Complete Installation first.

Success Checklist

By the end of this page, you should have:

  • one saved rule
  • one allowed outcome used by that rule
  • one successful rule test in UI
  • chart activity in Dashboard or Analytics, and configure spike notifications in Alerts

Step 1: Start Services

If you started with docker-compose.demo.yml or docker-compose.prod.yml, all services are already running — skip to Step 2.

Checkpoint:

  • http://localhost:8888/ping responds
  • http://localhost:4200 loads login page
  • http://localhost:8025 opens Mailpit inbox (for invite/reset email validation)

Start infrastructure:

docker compose up -d

Start API:

Start frontend:

cd ezrules/frontend
npm install
npm start

Checkpoint:

  • http://localhost:8888/ping responds
  • http://localhost:4200 loads login page
  • http://localhost:8025 opens Mailpit inbox

Step 2: Log In

  1. Open http://localhost:4200
  2. Sign in with your created user
  3. Confirm sidebar shows: Dashboard, Rules, Shadow Rules, Rule Rollouts, Labels, Outcomes, Analytics, Rule Quality, Alerts

Step 3: Create a Rule

  1. Open Rules
  2. Click New Rule
  3. Create:
if $amount > 10000:
    return !HOLD
  1. Leave Rule Lane set to Main rules
  2. Save

Checkpoint:

  • Rule appears in rules list
  • Rule detail page opens with Test Rule panel

Rule test panel with successful HOLD result

Step 4: Ensure Outcome Exists

  1. Open Outcomes
  2. Add HOLD if it does not exist yet
  3. Save any changes

Step 5: Test the Rule in UI

  1. Return to the rule detail page
  2. In Test Rule, paste:
{
  "transaction_id": "txn_001",
  "effective_at": "2026-04-23T12:00:00Z",
  "event_data": {
    "amount": 15000,
    "user_id": "user_42"
  }
}
  1. Run test

Checkpoint:

  • Test indicates outcome HOLD

Step 6: Add Labels and Verify Analytics

  1. Open Labels
  2. Create the labels you want to use operationally (for example FRAUD, NORMAL, CHARGEBACK)
  3. Mark events or upload a small CSV from the Labels page
  4. Open Analytics
  5. Set the time range to Last 30 Days and check total labeled count and trend charts
  6. Open Settings → General, add curated outcome→label pairs to track
  7. Open Rule Quality and confirm pair metrics load for curated pairs

You can also upload a small transaction_id,label_name CSV in Labels and recheck the charts.

30-day label analytics charts

Rule quality report with ranked rules and pair metrics

Next Steps