roost.tools / osprey
Mirror of https://github.com/roostorg/osprey github.com/roostorg/osprey
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

osprey / osprey_ui /
at main 2 folders 14 files
public
src
.env.development
.env.production
.eslintrc-ci.json
.gitignore
.npmrc
.prettierrc
.skip-tree
Dockerfile
README.md
base-tsconfig.json
nginx.conf
package-lock.json
package.json
tsconfig.json
README.md

Osprey UI#

Prerequisites#

  • Node.js (version 16+ recommended)
  • npm package manager
  • 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.

  1. Install Dependencies
cd osprey_ui
npm install
  1. Start Development Server
npm 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