vendure/README.md

Vendure

A headless GraphQL ecommerce framework built on NestJS with TypeScript.

Status

Currently in pre-alpha, i.e. it is not yet useable.

Structure

Vendure is a headless framework, which means that it is just an API serving JSON via a GraphQL endpoint. The code for the server is located in the server directory.

We will ship with an administration UI which is a stand-alone web application which can be used to perform tasks such as inventory, order and customer management. The code for this is located in the admin-ui directory.

Development

Server

The server requires an SQL database to be available. I am currently using bitnami-docker-phpmyadmin Docker image, which is MariaDB including phpMyAdmin.

Vendure uses TypeORM, so it compatible will any database which works with TypeORM.

• Configure the dev config
• cd server && yarn
• yarn start:dev
• Populate mock data with yarn populate

Admin UI

• cd admin-ui && yarn
• yarn start
• Go to http://localhost:4200 and log in with "admin@test.com", "test"

License

MIT