Skip to main content

Developer Documentation

This Node documents the live DealerOS application. DealerOS is an Nx and pnpm workspace with a Next.js web application, a NestJS API, shared TypeScript packages, and forward-only PostgreSQL migrations.

Local entry points

Install the pinned workspace dependencies, configure the values validated by packages/config/src/index.ts, apply the SQL migrations, and start the two applications:
The development targets bind the API to port 4000 and Next.js to port 3000. The API requires a database connection. Browser API calls are accepted only from the configured public app origin.
  • Architecture overview maps the applications, packages, persistence, auth boundary, configuration, and deployment shape.
  • Quickstart orients integrators with the authentication model and public integration points.
  • API reference lists the backend and web handlers that exist in the live application.