Generic lookup service

Monorepo for the multi-tenant lookup product documented under docs/lookup-service/.

Prerequisites

Tool	Notes
Node.js	v20+ (repo tested with v24)
npm	v10+
MongoDB	v7 recommended; optional for unit/integration tests (they use mongodb-memory-server)

Start Mongo locally:

docker compose up -d

Default connection: mongodb://127.0.0.1:27017 (see apps/api/.env.example).

Apps

Package	Description
apps/api	REST API — Express + TypeScript + MongoDB, contract validated with express-openapi-validator against apps/api/openapi.yaml
apps/web	Angular admin UI — tenants, namespaces, tables, entries (Material); uses proxy.conf.json to reach the API at /lookup/v1

Commands (from repo root)

npm install
npm run dev          # API dev server (tsx watch)
npm run dev:web      # Angular dev server (port 4200) with proxy to API — run API separately on :3000
npm run build        # compile API
npm run build:web    # production build of the Angular app (output under apps/web/dist)
npm run test         # Vitest: unit + integration (downloads Mongo binary on first run)
npm run test:contract   # OpenAPI / Postman JSON / seed script sanity (node:test)
npm run test:functional   # Newman Postman collection against ephemeral in-memory API

Web app details: apps/web/README.md.

Security note

JWT and perimeter hardening are not enabled in the current API build (local/dev trust model). Do not expose this stack to the public internet until auth and security middleware are restored. See docs/lookup-service/implementation.md.

Dependency audit

Run npm audit regularly. Some transitive warnings come from Newman/Postman runtime; review before applying --force upgrades.