Architecture Overview

Vendure Architecture Overview

Vendure is built with an internal architecture based on NestJS modules. It is not necessary to be familiar with all the internal modules, but a simplified overview can help to see how the major parts fit together. Here is a simplified diagram of the Vendure application architecture:

Entry Points

As you can see in the diagram, there are two entry points into the application: bootstrap() and bootstrapWorker(), which start the main server and the worker respectively.

GraphQL APIs

There are 2 separate GraphQL APIs: shop and admin.

  • The Shop API is used by public-facing client applications (web shops, e-commerce apps, mobile apps etc.) to allow customers to find products and place orders.

    Shop API Documentation.

  • The Admin API is used by administrators to manage products, customers and orders.

    Admin API Documentation.

Database

Vendure supports multiple databases. Currently it is tested with MySQL/MariaDB, PostgreSQL, SQLite and SQL.js. Since Vendure uses TypeORM to manage data access, it can theoretically also work with CockroachDB, Microsoft SQL Server and MongoDB, though these are as yet untested.

Custom Business Logic (Plugins)

Not shown on the diagram (for the sake of simplicity) are plugins. Plugins are the mechanism by which you extend Vendure with your own business logic and functionality. See the Plugins docs