Home / Project guide

Project guide

Project Guide | TwinCity UI

Free public-API readiness worksheet for city/service dashboards and runtime scorecards. This guide organizes the repository's original implementation notes for public API integrators and operations dashboard builders.

Reviewed 2026-07-28. This page is derived from checked-in repository evidence and links back to its source.

TwinCity UI — Digital Twin Ops Console

Product proof surface TwinCity UI leads with the working spatial operations console: synthetic event replay, dispatch queues, readiness checks, report exports, and handoff surfaces. Commercial exploration is limited to the private inquiry lane listed in the service manifest.

Next.js (React/TypeScript) operations console for spatial event management. Overlays zones and events on a floorplan, connecting the spatial view to the full operator workflow: ingest, normalization, triage, dispatch, SLA reporting, and shift handoff.

Technical review pack: `docs/architecture-pack.md`

System Overview

LensDecision signal
UsersFacilities, city operations, and industrial command centers that need spatial incidents, dispatch, and SLA evidence in one console.
Product proofThe demo, workflow loop, and static proof surface show the current product direction without production or customer claims.
Review proof/api/proof-route-map, /api/health, /api/meta, runtime scorecard, reports, and screenshot evidence create a fast evaluation path.
Safety postureDemo-mode defaults, trust-boundary metadata, normalized ingest, and explicit fallback behavior keep the public surface understandable and low-risk.

Evaluation Path

Architecture Notes

Product capabilities

Quick start

npm ci
npm run dev

Open http://127.0.0.1:3000/events.

Walk Through This First

If you only have a minute, use this order:

  1. /api/proof-route-map — pick the right first proof lane before opening the full console
  2. /api/health — confirm whether the console is in demo mode or attached to live ingest
  3. /api/meta — read the trust boundary and evidence bundle
  4. /api/runtime-scorecard — inspect ingest posture and SLA summary together
  5. /reports — see the dispatch, handoff, and export surfaces that make the operator story concrete

Public review surface

Verify

npm run test:proof
npm run verify

Key routes

Live sources (optional)

Create .env.local from .env.local.example:

NEXT_PUBLIC_EVENT_WS_URL=wss://example.com/events
NEXT_PUBLIC_EVENT_STREAM_URL=https://example.com/events/stream
NEXT_PUBLIC_EVENT_API_URL=https://example.com/events
NEXT_PUBLIC_EVENT_POLL_MS=5000

Without live sources, the app runs in demo mode with mock data.

Optional Korean public-data enrichment is exposed through /api/public-apis. The readiness registry is aligned with public-apis-4Kr and checks for server-side provider secrets such as SEOUL_OPEN_DATA_API_KEY, KMA_API_KEY, AIRKOREA_API_KEY, and PUBLIC_SAFETY_API_KEY without returning secret values.

Mock endpoints

Docs

Current limitations

Next

Cloud + AI Architecture

Enterprise Productization

System Architecture

Service Architecture

Search And Service Surface