Documentation Portal

Get the local bridge workspace running.

Use this page for the first local setup pass: install dependencies, configure env files, verify the secure shell contract, and run the repository checks in the required order.

Documentation map

The docs portal stays in the same application as the product shell so setup, deployment, connector, and developer guidance can evolve with the codebase.

In-repo docs7 foundation routes5 developer routesCurrent: Getting Started

Foundation docs

  • OverviewRoute

    Start with the current architecture, product surfaces, and the stable documentation sections.

  • Getting StartedOpen

    Install the workspace, configure local env files, and run the first verification flow.

  • DeploymentRoute

    Use the managed bridge deployment order, health checks, migrations, and workspace bootstrap flow.

  • ConnectorsRoute

    Understand the Figma reference connector, Satellite runtime, and explicit session routing model.

  • SecurityRoute

    Review auth lanes, workspace isolation, policy controls, rate limiting, and audit semantics.

  • API ReferenceRoute

    Browse the stable HTTP route groups, shared envelopes, auth lanes, and machine-readable errors.

  • TroubleshootingRoute

    Use the current operational failure patterns for readiness, auth, session liveness, policy, and MCP issues.

Developer docs

  • DevelopersRoute

    Developer-facing entry point for HTTP, MCP, connector, and shared-contract guidance.

  • Developer QuickstartRoute

    Bring up the bridge, connect one runtime, and make the first explicit authenticated calls.

  • HTTP GuideRoute

    Use the bridge HTTP transport with the correct auth lane, shared envelopes, and explicit targetSessionId routing.

  • MCP GuideRoute

    Use the Streamable HTTP MCP endpoint, LIST_CAPABILITIES, and the same connector-neutral tool catalog.

  • Connector ModelRoute

    Understand connector definitions, capability metadata, data scopes, and high-risk policy presets.

Prerequisites

The repository expects the same local baseline across bridge, web, Figma, and Satellite slices.

Node.js 20+npm 10+RedisPostgres or Supabase-compatible PostgresFigma access for the reference connector
  • Install workspace dependencies with npm install.
  • Copy apps/bridge-server/.env.example to apps/bridge-server/.env.
  • Copy apps/web/.env.example to apps/web/.env when you use the secure shell or fake-door routes.

Managed SaaS reference hosts

Local development can stay on localhost, but the current managed SaaS reference topology uses separate hosts for the web surface, bridge, and Supabase.

  • https://draftlinkapp.com and https://www.draftlinkapp.com serve apps/web from Vercel.
  • https://bridge.draftlinkapp.com is the managed bridge host used for BRIDGE_SERVER_URL.
  • https://supabase.draftlinkapp.com is the managed Supabase host used for NEXT_PUBLIC_SUPABASE_URL.

Secure-shell environment contract

The authenticated web shell needs both bridge and Supabase values before protected routes can render workspace data.

Required bridge variable: BRIDGE_SERVER_URL

Required Supabase variables: NEXT_PUBLIC_SUPABASE_URL and NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY

Legacy preview helper variable: BRIDGE_SERVER_API_KEY only when you intentionally use the older preview helpers in apps/web/app/lib/bridge.ts

Managed reference values: BRIDGE_SERVER_URL=https://bridge.draftlinkapp.com and NEXT_PUBLIC_SUPABASE_URL=https://supabase.draftlinkapp.com

Verification order

A full repository rebuild is defined in the repo rules and should stay consistent across local and agent-driven verification.

  1. Run npm run build.
  2. Run npm run test.
  3. Run npm run lint.
  4. Run npm run typecheck.

Managed-host preflight

When you switch from localhost values to the managed SaaS reference topology, validate the host split before treating the deployment as ready.

Run npm run validate:managed-topology when you want one repo-level cutover preflight for the full managed reference topology.

Run npm run validate:managed-saas-topology --workspace @uab/web.

The command checks that BRIDGE_SERVER_URL points to https://bridge.draftlinkapp.com and NEXT_PUBLIC_SUPABASE_URL points to https://supabase.draftlinkapp.com.

Run npm run validate:managed-deployment-topology --workspace @uab/bridge-server.

The bridge-side preflight checks that SUPABASE_URL points to https://supabase.draftlinkapp.com and that SOCKET_CORS_ORIGIN stays either wildcard for the first proof or a valid HTTPS allowlist for the hardened browser-facing setup.