Mirror of https://github.com/roostorg/osprey
github.com/roostorg/osprey
1# Osprey UI
2
3### Prerequisites
4
5- Node.js (version 16+ recommended)
6- npm package manager
7- Docker (for backend services)
8
9## Purpose
10
11`osprey_ui` is the frontend repository for the Osprey application.
12For more information on the application as a whole, its features,
13and what it is used for, please refer to the [documentation](https://github.com/roostorg/osprey/tree/main/docs). This is a `create-react-app` project. It uses React/Typescript/Zustand,
14[Ant Design 4.0](https://ant.design/) as a UI framework, and CSS Modules.
15
16### Service Dependencies
17
18- **Osprey UI API** - Main backend API
19- **Osprey Worker** - Rules processing engine
20- **Kafka** - Message streaming
21- **PostgreSQL** - Database
22- **Druid** - Analytics engine
23
24## Development Setup
25
261. **Start Backend Services**
27
28```bash
29# From the osprey project root directory
30docker compose up -d
31```
32
33This starts all required backend services including Kafka, PostgreSQL, Druid, and the Osprey API.
34
352. **Install Dependencies**
36
37```bash
38cd osprey_ui
39npm install
40```
41
423. **Start Development Server**
43
44```bash
45npm start
46```
47
48The UI will be available at **http://localhost:5002** unless otherwise specified, and will automatically connect to the backend services running in Docker containers.
49
50## Deploy
51
52TODO: TBD