# vendure-ecommerce/vendure architecture

> Architecture diagram of the GitHub repository vendure-ecommerce/vendure, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vendure-ecommerce/vendure
- Repository: https://github.com/vendure-ecommerce/vendure

## Overview

##### 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).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Monorepo root
    MR["Monorepo Root"]:::root
    click MR "https://github.com/vendure-ecommerce/vendure/blob/master/lerna.json"

    %% Core Server
    CoreServer["Core Server (NestJS)"]:::core
    click CoreServer "https://github.com/vendure-ecommerce/vendure/tree/master/packages/core"

    %% Dev-Server
    DevServer["Dev-Server"]:::core
    click DevServer "https://github.com/vendure-ecommerce/vendure/tree/master/packages/dev-server"

    %% Plugins
    subgraph "Vendure Plugins"
        direction TB
        AssetPlugin["Asset Server Plugin"]:::plugin
        ElasticsearchPlugin["Elasticsearch Plugin"]:::plugin
        EmailPlugin["Email Plugin"]:::plugin
        PaymentsPlugin["Payments Plugin"]:::plugin
        TelemetryPlugin["Telemetry Plugin"]:::plugin
        click AssetPlugin "https://github.com/vendure-ecommerce/vendure/tree/master/packages/asset-server-plugin"
        click ElasticsearchPlugin "https://github.com/vendure-ecommerce/vendure/tree/master/packages/elasticsearch-plugin"
        click EmailPlugin "https://github.com/vendure-ecommerce/vendure/tree/master/packages/email-plugin"
        click PaymentsPlugin "https://github.com/vendure-ecommerce/vendure/tree/master/packages/payments-plugin"
        click TelemetryPlugin "https://github.com/vendure-ecommerce/vendure/tree/master/packages/telemetry-plugin"
    end

    %% Admin UIs
    subgraph "Admin UIs"
        direction TB
        AngularUI["Legacy Angular Admin UI"]:::ui
        ReactUI["React Admin UI"]:::ui
        click AngularUI "https://github.com/vendure-ecommerce/vendure/tree/master/packages/admin-ui"
        click ReactUI "https://github.com/vendure-ecommerce/vendure/tree/master/packages/dashboard"
    end

    %% CLI, Docs, Devkit, Testing, Common
    CLI["CLI (vendure)"]:::cli
    click CLI "https://github.com/vendure-ecommerce/vendure/tree/master/packages/cli"
    DocsSite["Docs Site (Docusaurus)"]:::docs
    click DocsSite "https://github.com/vendure-ecommerce/vendure/tree/master/docs/"
    Devkit["UI Devkit"]:::core
    click Devkit "https://github.com/vendure-ecommerce/vendure/tree/master/packages/ui-devkit"
    Testing["Testing Utils"]:::core
    click Testing "https://github.com/vendure-ecommerce/vendure/tree/master/packages/testing"
    CommonPkg["Common Package"]:::core
    click CommonPkg "https://github.com/vendure-ecommerce/vendure/tree/master/packages/common"

    %% External Services
    subgraph "External Services"
        direction TB
        DB["Database"]:::external
        Redis["Redis (Cache & Queue)"]:::external
        ESService["Elasticsearch Service"]:::external
        S3["S3 / Local FS"]:::external
        Mail["Mail Server / Dev Mailbox"]:::external
    end

    %% Connections
    MR --> CoreServer
    MR --> DevServer
    MR --> AssetPlugin
    MR --> ElasticsearchPlugin
    MR --> EmailPlugin
    MR --> PaymentsPlugin
    MR --> TelemetryPlugin
    MR --> AngularUI
    MR --> ReactUI
    MR --> CLI
    MR --> DocsSite
    MR --> Devkit
    MR --> Testing
    MR --> CommonPkg

    DevServer --> CoreServer
    DevServer --> AssetPlugin
    DevServer --> EmailPlugin

    CoreServer --> DB
    CoreServer --> CommonPkg
    CoreServer --> Redis
    CoreServer --> CommonPkg
    CoreServer --> CommonPkg

    Redis <-->|"cache & sessions"| CoreServer
    Redis <-->|"job queue"| CoreServer

    AssetPlugin --> S3
    ElasticsearchPlugin --> ESService
    EmailPlugin --> Mail

    AngularUI -->|"HTTP API"| CoreServer
    ReactUI -->|"HTTP API"| CoreServer

    CLI --> CommonPkg
    CLI --> Devkit

    %% Styles
    classDef root fill:#eeeeee,stroke:#888888,stroke-width:2px;
    classDef core fill:#cce5ff,stroke:#2b6cb0,stroke-width:2px;
    classDef plugin fill:#ffe5b4,stroke:#dd6b20,stroke-width:2px;
    classDef ui fill:#d4edda,stroke:#2f855a,stroke-width:2px;
    classDef cli fill:#f0f0f0,stroke:#4a5568,stroke-width:2px;
    classDef docs fill:#f7fafc,stroke:#718096,stroke-width:2px;
    classDef external fill:#fed7d7,stroke:#c53030,stroke-width:2px;
```
