title: "Getting Started"

weight: 0

Getting Started

Requirements

Node.js v8 or above
An SQL database compatible with TypeORM, i.e. MySQL, MariaDB, PostgreSQL, SQLite, Microsoft SQL Server, sql.js, Oracle.

Installation

The following instructions describe how to run a development instance of Vendure using ts-node and SQLite.

Set up the database

You'll need a database to store your shop data. The simplest way to try out Vendure is to use SQLite, since it does not require a separate database server to work.

$ npm install sqlite3

Install ts-node

This allows us to run TypeScript directly without a compilation step. Useful for development.

$ npm install --save-dev ts-node

Install Vendure

$ npm install @vendure/core

Initialize with the Vendure CLI

Vendure includes a CLI program which can generate the initial configuration and entry file for your server:

$ npx vendure init

The init command will ask a series of questions which allow the CLI to generate a configuration and index file.

Run

Once the init script has completed, the server can be started.

$ ts-node index

Assuming the default config settings, you can now access:

The Vendure GraphQL API: http://localhost:3000/api
The Vendure Admin UI: http://localhost:3000/admin

{{% alert primary %}} Log in with the superadmin credentials:

username: superadmin
password: superadmin {{% /alert %}}

getting-started.md 1.6 KB History Raw