ODIS UI

Faceted search UI for ODIS metadata records. Read-only FastAPI backend + Svelte frontend.

Search is backed by the odis_metadata Elasticsearch index. See docs/faceted-search-plan.md and docs/data-sources-analysis.md for background.

Prerequisites

• Docker
• Access to external Elasticsearch with the odis_metadata index

Quick start (development)

git clone https://github.com/iobis/odis-ui.git
cd odis-ui
cp .env.example .env
docker compose up --build

Open http://localhost:8080

• Frontend: http://localhost:8080/
• API health: http://localhost:8080/api/v1/health
• API docs (Swagger): http://localhost:8080/api/docs
• API docs (ReDoc): http://localhost:8080/api/redoc

Production

Production runs nginx (static UI + reverse proxy) and the API in Docker. TLS uses host-installed Certbot with certificates on the VPS filesystem, bind-mounted into the nginx container.

Prerequisites

• A domain pointing at the VPS (DNS A/AAAA record)
• Ports 80 and 443 open in the firewall
• Docker on the VPS
• Certbot on the host:

sudo apt update && sudo apt install -y certbot
sudo mkdir -p /var/www/certbot

First deploy with TLS

sudo ./scripts/init-letsencrypt.sh

Updates (after TLS bootstrap)

./scripts/deploy-prod.sh --pull

Running tests

cd api && pip install -e ".[dev]" && pytest

Or via Docker:

docker compose run --rm api pytest