ORD Explorer

A standalone web app for exploring ORD (Open Resource Discovery) documents — connect to any ORD-compliant system endpoint or document URL, browse its resources, and inspect definitions.

Live Demo

👉 open-resource-discovery.github.io/explorer

What it is

The app manages one or more connections (system endpoints or direct document URLs). For each connection it fetches, merges, and renders a three-level browsing UI:

• Catalog — per-type stat cards (APIs, Events, Entity Types, Data Products) with counts and search
• Resource list — resources grouped by ORD package, with fuzzy search and visibility/release-status filters
• Resource detail — full description, schema, documentation, changelog, and raw JSON tabs

Authentication options: none, static bearer token, or mTLS (via local proxy — see below).

Setup

npm install

Commands

| Command | Description | | ------------------ | ----------------------------------- | | npm run dev | Start the dev server | | npm run build | Type-check and build to dist/ | | npm run lint | Run ESLint | | npm run format | Run Prettier + ESLint with auto-fix | | npm test | Run unit tests | | npm run test:e2e | Run Playwright end-to-end tests |

mTLS proxy

mTLS connections require the local auth proxy (browser fetch cannot attach client certificates). Run it alongside the dev server:

npm run proxy          # from the repo root — starts the compiled proxy

Or run it directly from source during development:

cd auth-proxy
npm run dev:server     # start the proxy from source

Local mTLS test server

To test end-to-end mTLS without a real endpoint, use the included dev server:

cd auth-proxy
npm run dev:gen-certs  # generate self-signed certs (once)
npm run dev:server     # start an mTLS-enforced ORD server on https://localhost:44124

Then add a connection in the app:

• Base URL: https://localhost:44124
• Auth: mTLS
• Client cert / key / CA: auth-proxy/dev/certs/client.crt, client.key, ca.crt

Architecture decisions

Significant design decisions are recorded as ADRs in docs/adr/. New decisions should be added there.

Contributing

Please see CONTRIBUTING.md for details on how to contribute to this project.

License

Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.