Quick Start Guide

Quick Start Guide

Welcome to the RDCP demo. This guide gets you from a clean clone to a working demo showing both the RDCP server (port 3000) and the Admin app (port 3100).

Links: Validation Scripts • Architecture Overview • Troubleshooting • Demo Scenarios

Prerequisites

• Node 18+ and npm 9+
• macOS or Linux shell (zsh/bash)

Environment variables

• RDCP_API_KEY (dev default)
  • For local demo only: dev-key-change-in-production-min-32-chars
• Optional:
  • RDCP_BASE_URL (default: http://localhost:3000)
  • RDCP_CLIENT_ID (default: values set by scripts)

Set in your shell before running commands if desired:

export RDCP_API_KEY='dev-key-change-in-production-min-32-chars'

Ports

• RDCP Demo Server: 3000
• Admin App (SSR UI + JSON): 3100

See also: Known Issues & Status

Fresh clone + two-terminal startup

From an empty directory:

git clone https://github.com/mojoatomic/rdcp
cd rdcp
npm ci
npm run build

Terminal A — RDCP demo server (port 3000):

npm run dev --prefix packages/rdcp-demo-app

Terminal B — Admin App (port 3100):

npm run start --prefix packages/rdcp-admin-app

Notes

• No manual per-package installs are required. Workspaces plus the unified build handle all packages (including admin and the OpenTelemetry plugin).
• If npm is older and does not install workspace deps automatically, run:

  npm install --prefix packages/rdcp-demo-app

Access URLs

• RDCP Protocol index: http://localhost:3000/.well-known/rdcp
• RDCP endpoints: http://localhost:3000/rdcp/v1/{discovery,status,control,health}
• Admin UI (SSR): http://localhost:3100/admin
• Admin JSON (data only):
  • AdminUISpec: http://localhost:3100/admin/spec
  • Discovery+Status: http://localhost:3100/admin/json

Quick validation

• You should see JSON at /.well-known/rdcp and at /admin/spec + /admin/json.
• If UI returns 500 about react-dom, see Troubleshooting.

RDCP Admin Interface — User Guide

The interface has three main sections:

1. Data Access Links (top)

• "Raw JSON (discovery + status)" — View the underlying RDCP protocol responses
• "AdminUISpec JSON (headless builder)" — See the generated Admin UI specification

2. Debug Category Controls (middle)

• Seven checkboxes for debug categories: DATABASE, API_ROUTES, QUERIES, REPORTS, CACHE, AUTH, INTEGRATIONS
• Check boxes to select which categories you want to control
• All checkboxes are initially unchecked (disabled state)

3. Control Panel (bottom)

• Status — shows current server state with timestamp
• Action dropdown — choose the operation: enable, disable, toggle, or reset
• Apply button — execute the selected action on the checked categories

How to use:

1. Check one or more debug category boxes
2. Select an action from the dropdown (default: enable)
3. Click "Apply"
4. Watch the Status timestamp update to reflect the change
5. Visit the JSON links to see the actual protocol state changes

Tip: Try both enable and disable actions to observe the state toggling live.