Skip to content
OLS Product Docs

Platform architecture

The OLS platform is a single-page web application backed by a REST API.

Components

Section titled “Components”
  • Web client — a React single-page application that talks to the API over HTTPS.
  • API — a NestJS service exposing the REST surface documented in the API reference. Its contract is defined by an OpenAPI specification, from which the typed client is generated.
  • Database — a PostgreSQL instance holding the platform’s persistent state.

Contract-first API

Section titled “Contract-first API”

The API surface is contract-first: the OpenAPI specification is the source of truth, and both the server validation and the client types are derived from it. This keeps the documented surface and the running surface in step.

Where to go next

Section titled “Where to go next”