-
Notifications
You must be signed in to change notification settings - Fork 0
Architecture Overview
Doug Fennell edited this page Sep 29, 2025
·
1 revision
This page explains how the RDCP demo is structured and how data flows through the system.
Links: Quick Start Guide β’ Validation Scripts β’ Troubleshooting β’ Demo Scenarios
- @rdcp.dev/core (packages/rdcp-core)
- Protocol constants, headers, error codes, validation schemas, fixtures
- @rdcp.dev/client (packages/rdcp-client)
- Fetch-based client that calls RDCP endpoints (discovery/status/control/health)
- @rdcp.dev/admin-ui (packages/rdcp-admin-ui)
- Headless builder that produces an AdminUISpec from RDCP discovery
- @rdcp.dev/admin-ui-react (packages/rdcp-admin-ui-react)
- React components that render AdminUISpec server-side
- @rdcp.dev/admin-app (packages/rdcp-admin-app)
- Express server that exposes:
- /admin (SSR HTML)
- /admin/spec (AdminUISpec JSON using headless builder)
- /admin/json (discovery + status JSON using the client SDK)
- Express server that exposes:
- Demo App (packages/rdcp-demo-app)
- RDCP-compliant endpoints on port 3000
Browser / Tool
| (HTTP)
v
http://localhost:3100/admin/json http://localhost:3100/admin/spec
| |
| (calls @rdcp.dev/client) | (calls @rdcp.dev/admin-ui)
v v
RDCP Server (port 3000) <ββ discovery ββ @rdcp.dev/admin-ui
^ ^ |
| ββ status | uses
βββ control (POST) ββ discovery JSON
GET /admin (3100)
-> Admin App SSR handler
-> creates RDCP client (baseUrl: http://localhost:3000)
-> fetches discovery
-> builds AdminUISpec via @rdcp.dev/admin-ui
-> renders with @rdcp.dev/admin-ui-react and react-dom/server
-> returns HTML including polling + Apply inline script
- Clean separation of concerns:
- Demo App (port 3000): implements RDCP protocol; minimal, framework-agnostic
- Admin App (port 3100): presentation layer; SSR + client hydration; consumes the protocol
- Realistic deployment model:
- In production, operational UI often lives outside service processes
- Dogfooding both sides:
- Validates the client SDK and the headless builder independently of the server implementation
Getting Started: Installation β’ Basic Usage β’ Authentication
Migration: From Manual Implementation β’ Framework Examples β’ Publishing Guide
Protocol: RDCP v1.0 Specification β’ Implementation Guide β’ API Reference
π Home | π¦ NPM Package | π GitHub | π Issues
RDCP SDK v1.0.0 - Runtime Debug Control Protocol implementation for JavaScript/Node.js applications
- Implementation-Status
- JavaScript-vs-TypeScript-Boundaries
- Core-Package-Boundaries
- Publishing-Setup
- Contributing
- API-Reference
- Protocol Specification
- Implementation Guide
- RDCP-Primitive-Types
- Protocol-Schemas
- Protocol-Error-Codes
- API-Reference
Version: 1.0.0
Protocol: RDCP v1.0
License: Apache-2.0