UI Frame

Setup

Running the dashboard against your Engine.

Prerequisites

  • Bun (recommended) or Node.js v20+
  • The Engine backend running on http://localhost:5201

The Engine must be up for API calls to succeed. UI Frame will render without it, but every data view will error.

Install

cd uiframe
bun install

Configure

Create .env.local in the uiframe directory. The one required value points the dashboard at your backend:

# Point to your local Engine instance
NEXT_PUBLIC_API_BASE_URL=http://localhost:5201/api/v1

Run

bun run dev

The dev server runs on port 5200 by default, chosen to avoid colliding with the backend. Open http://localhost:5200.

UI Frame

The admin layer — Next.js and shadcn/ui, wired to the Engine API.

Multi-tenancy

How the frontend inherits tenant scope.

On this page

PrerequisitesInstallConfigureRun