Getting Started
This section covers everything you need to get the Data Hub plugin running in your Vendure project.
Contents
- Installation - Add the plugin to your Vendure project
- Quick Start - Create your first pipeline in 5 minutes
- Core Concepts - Understand pipelines, steps, and data flow
Prerequisites
- Vendure Core and Dashboard >=3.5.7 <4.0.0
- TypeORM >=0.3.29 <0.4.0
- Node.js >=20.0.0
- A running Vendure server with the Dashboard enabled
Overview
The Data Hub plugin adds ETL (Extract, Transform, Load) capabilities to Vendure:
- Extract - Pull data from external sources (APIs, databases, files)
- Transform - Clean, validate, and map data to Vendure formats
- Load - Create or update Vendure entities (products, customers, etc.)
You can build pipelines using either:
- Visual Builder - Drag-and-drop interface in the Vendure Dashboard
- Code-First DSL - TypeScript API for defining pipelines in code
Next Steps
Start with Installation to add the plugin to your project.