Osprey UI#

Prerequisites#

• Node.js (version 22+ required)
• pnpm (via Corepack — auto-resolved from the packageManager field in package.json; no separate install needed once Node.js 22+ is on the host)
• Docker (for backend services)

Purpose#

osprey_ui is the frontend repository for the Osprey application. For more information on the application as a whole, its features, and what it is used for, please refer to the documentation. This is a create-react-app project. It uses React/Typescript/Zustand, Ant Design 4.0 as a UI framework, and CSS Modules.

Service Dependencies#

• Osprey UI API - Main backend API
• Osprey Worker - Rules processing engine
• Kafka - Message streaming
• PostgreSQL - Database
• Druid - Analytics engine

Development Setup#

1. Start Backend Services

# From the osprey project root directory
docker compose up -d

This starts all required backend services including Kafka, PostgreSQL, Druid, and the Osprey API.

2. Install Dependencies

cd osprey_ui
pnpm install --frozen-lockfile

3. Start Development Server

pnpm start

The UI will be available at http://localhost:5002 unless otherwise specified, and will automatically connect to the backend services running in Docker containers.

Deploy#

TODO: TBD