// readme

CIRCUS

This is a monorepo that contains all CIRCUS projects.

  • circus-api: JSON-based REST API server
  • circus-web-ui: Front-end code for CIRCUS web UI
  • circus-rs: Web-based DICOM viewer with 3D annotation capability
  • circus-cs-core: Includes job manager daemon and CS related code
  • circus-icons: Icons used by CIRCUS projects
  • circus-ui-kit: Includes React-bindings of CIRCUS RS and displays for CS results display
  • circus-lib: Code shared among the above projects

Install

The easiest way to get CIRCUS working is to use Docker Compose. CIRCUS consists of the following containers:

ServiceImageDescription
mongomongo:9.0MongoDB (replica set rs0)
apighcr.io/utrad-ical/circus-apiAPI server, CIRCUS RS, and CS job manager
webghcr.io/utrad-ical/circus-webWeb UI served by Caddy, proxying /api, /login, /rs

Each service belongs to a profile of the same…