How vendure-ecommerce/vendure works
Project type and purpose
• Vendure is an open-source, headless commerce platform.
• It lives in a Lerna-managed monorepo containing:
– Core server (NestJS GraphQL APIs)
– Plugins (asset server, Elasticsearch, payments, etc.)
– Dev-server (boots up Core + plugins + asset server + mail dev-mailbox)
– Admin UI (React v3, legacy Angular v2 UI)
– CLI (scaffolding & codegen tool)
– Docs site (Docusaurus)
File structure
• Top-level:
– packages/ → all published npm packages
– docs/ → documentation source & Docusaurus config
– scripts/ → build, codegen, documentation generators
– docker-compose.yml → infrastructure (DB, Elasticsearch, Redis, etc.)
• Key sub-directories under packages/:
– core/ → the GraphQL server modules, TypeORM entities, services, event bus, scheduler, job-queue, cache
– dev-server/ → entrypoint that loads core + plugins and exposes GraphQL endpoints, asset server, dev mailbox
– admin-ui/ → Angular-based UI (legacy) and React-based UI (new) under src/lib
– cli/ → vendure command-line tool for scaffolding projects & extensions
– plugins/… → individual plugin packages (e.g. asset-server-plugin, email-plugin, payments-plugin, etc.)
– ui-devkit/ → tools to scaffold and compile Admin UI extensions
– testing/ → utilities for e2e and unit tests
README for additional insights
• The README confirms technologies: Node.js, NestJS, GraphQL, TypeScript, TypeORM, Docusaurus.
• It outlines development workflow: build packages, run docker services, populate test data, start dev-server, optionally run Admin UI separately or via dev-server.
• Emphasis on plugin extension model, monorepo CI/CD via GitHub Actions + Lerna.
Detail & granularity
• That the CLI invokes codegen to generate files under packages/common and packages/admin-ui.
• Event bus & job queue as separate internal modules if relevant to your audience.
• Optional services (e.g. Elasticsearch only if enabled).