Vendure

An open-source headless commerce platform built on Node.js with GraphQL, Nest & TypeScript, with a focus on developer productivity and ease of customization.

Important

We're introducing our new React-based Admin Dashboard
Check out the preview now: v3.4.0 release notes
We're phasing out our Angular-based Admin UI with support until June 2026: Read more here

www.vendure.io

🚀 Getting Started

New to Vendure? Start here:

• Getting Started Guide: Get Vendure up and running locally in minutes with a single command
• Public Demo: Take a look at the Vendure Admin UI
• Documentation: Comprehensive guides, API reference, and tutorials

Need Help?

• Vendure Discord: Join our community for support and discussions

🔧 Contributing - For developers

Want to contribute to Vendure?

Contributions to Vendure are welcome and highly appreciated! Whether you're fixing bugs, adding features, or improving documentation, your help makes Vendure better for everyone.

Contribution Guidelines - This is complete guide covering everything from setting up your development environment to submitting your first pull request

Ready to get started?

Check out our list of issues labeled "contributions welcome" for good first issues

We're here to help if you have questions, and we're excited to see what you'll build with Vendure!

Branches

• master - The latest stable release, currently the 3.x series.
• minor - The next minor release, including new features
• major - The next major release (v4.0)
• v2.x - The 2.x line, which will receive critical fixes until the end-of-life on 31.12.2024. The code in this branch is under the MIT license.

Structure

This project is a monorepo managed with Lerna. Several npm packages are published from this repo, which can be found in the packages/ directory.

vendure/
├── docs/           # Documentation source
├── e2e-common/     # Shared config for package e2e tests
├── license/        # License information & CLA signature log
├── packages/       # Source for the Vendure server, admin-ui & core plugin packages
├── scripts/
    ├── changelog/  # Scripts used to generate the changelog based on the git history
    ├── codegen/    # Scripts used to generate TypeScript code from the GraphQL APIs
    ├── docs/       # Scripts used to generate documentation markdown from the source

License

See LICENSE.md.