Guides

Examples and Deployment

DSAR includes runnable examples for local development, integration experiments, and product embedding patterns.

Example Catalog

ExamplePurposeWhen to use it
examples/kitchen-sinkFull local runtime with SQLite, filesystem artifacts, and walkthrough scriptsStart here when you want broad lifecycle coverage fast
examples/dashboardOperator-facing Next.js appExplore admin and operator flows
examples/subject-portalSubject-facing Next.js appExplore request submission, verification, and appeals
examples/local-storageRuntime wired to filesystem storageValidate local artifact persistence
examples/vercel-storageRuntime wired to Vercel Blob plus an upload demoValidate Blob-backed artifact storage and demo uploads

Recommended Local Stack

For the broadest local setup, run:

Then use:

  • http://kitchen-sink.localhost:1355/api/v1/status
  • http://kitchen-sink.localhost:1355/api/v1/spec.json
  • http://kitchen-sink.localhost:1355/api/v1/docs
  • http://dashboard.localhost:1355
  • http://subject-portal.localhost:1355

Deployment Patterns

Self-Hosted Runtime

Embed @dsar/backend into your own service, choose a persistence layer, then register storage, inbound, outbound, and auth integrations as needed.

Start with:

Server-Side Product Integration

Use @dsar/node-sdk or @dsar/core from trusted backend code in your product. This is the preferred shape for dashboards, automation, and subject portals.

Browser-Facing Portals

Do not expose DSAR machine credentials in the browser. Authenticate the user in the host app first, then call DSAR from a server action, route handler, or backend service.

See Auth Model.

Infrastructure Scope

This workspace does not currently provide one canonical container or production infrastructure recipe. The examples are intended as composition references for runtime wiring, auth boundaries, and storage choices rather than turnkey production deployment manifests.

See Testing Acceptance and Parity.