Getting Started


  • Node.js v12 or above, with support for even-numbered Node.js versions.
  • If you want to use MySQL, MariaDB, or Postgres as your data store, then you’ll need an instance available locally. However, if you are just testing out Vendure, we recommend using SQLite, which has no external requirements.
  • For Windows users: make sure you have windows build tools installed
    • npm install --global --production windows-build-tools
    • This step should be done with administrative rights, and is required because Vendure makes use of some dependencies which must be compiled upon installation.

Installation with @vendure/create

The recommended way to get started with Vendure is by using the @vendure/create tool. This is a command-line tool which will scaffold and configure your new Vendure project and install all dependiencies.

npx @vendure/create my-app

npx comes with npm 5.2+ and higher.

npm init @vendure my-app

npm init <initializer> is available in npm 6+

yarn create @vendure my-app

yarn create is available in Yarn 0.25+

For other installation options see the @vendure/create documentation.

“my-app” in the above command would be replaced by whatever you’d like to name your new project. Vendure Create will guide you through the setup. When done, you can run:

cd my-app

yarn start
# or
npm run start

Assuming the default config settings, you can now access:

Log in with the superadmin credentials:

  • username: superadmin
  • password: superadmin

Next Steps