Skip to main content

Quickstart (Lane A)

Create a local Lane-A product, install peers, and verify Collection access.

Prerequisites​

  • Node ≥ 20
  • Sibling checkouts or vendor path for @chbrdk/plexon-federation and @chbrdk/dic-app
  • Test Control Plane URL from knowledge/paths.md (staging plexon-v3)

Commands (fixture)​

From the plexon-v3 repo root:

npm run scaffold:lane-a -- --name demo-portal --skip-plexon

--skip-plexon keeps descriptor writes off the live plexon checkout (demo/throwaway). For a real product, omit the flag and follow knowledge/lane-a-scaffold.md.

Minimal app definition​

import { defineDicApp } from '@chbrdk/dic-app'
import { buildFederationHeaders } from '@chbrdk/plexon-federation'

export const app = defineDicApp({
productId: 'demo',
productName: 'Demo',
nav: [{ id: 'home', label: 'Home', href: '/' }],
settingsHref: '/settings',
})

export const headers = buildFederationHeaders({
contractVersion: '2026-05-plexon-federation-v3',
serviceSecret: process.env.PLEXON_SERVICE_SECRET!,
userId: process.env.PLEXON_STAGING_ACTOR!,
})

Verify​

  1. npm install in the generated app (registry, file: pin, or vendor/).
  2. Sign in with a test account that has at least one Collection grant.
  3. Call GET /api/platform/provisioning/accessible-collections with the headers above — expect your Collection id.

Install paths (document which you used):

PathWhen
GitHub Packages @chbrdk/plexon-federationPublished consumer
file:../plexon-v3/packages/...Monorepo sibling
vendor/Scaffolded offline tree