Build and run

Build-and-run entry point for ODD developers — Platform backend + frontend, the ODD Collectors family, and the SDK path for authoring brand-new collectors / adapters.

This section shows how to build and run code for each part of ODD infrastructure — ODD Platform backend and frontend, the ODD Collectors family, and the SDK path for authoring a brand-new collector or adapter when none of the bundled ones fits. For local Docker-based setup that does not require building from source, follow Try locally.

Contents

  • Build and run ODD Platform — backend (Java + Gradle + Spring WebFlux + jOOQ + Flyway) and frontend (TypeScript + React); how to run the platform from source for development.

  • Build and run ODD Collectors — Python collectors bundled in the odd-collectors monorepo (odd-collector, -aws, -gcp, -azure) plus the standalone odd-collector-profiler; how to set up a Python environment, install per-collector dependencies, and run a collector locally.

  • Build a custom collector — author a brand-new ODD collector or adapter against the odd-collector-sdk Python SDK when none of the bundled adapters fits the data source you want to ingest. End-to-end recipe: SDK setup, ODDRN generation, plugin registration, packaging.

Last updated