Home Explore Help
Sign In
cturan
/
vendure
mirror of https://github.com/vendure-ecommerce/vendure
1
0
Fork 0
Files Issues 0 Wiki

No Description

Tree: 89e52ef28b
Branches Tags
vendure
Michael Bromley 89e52ef28b chore(admin-ui): Set sass includePath 7 years ago
admin-ui 89e52ef28b chore(admin-ui): Set sass includePath 7 years ago
docs 1ce3a18118 Start documenting app as a class diagram 7 years ago
server faa051784e feat(server): Share dev config 7 years ago
.editorconfig 2de502b09e chore(server): Set the correct indentation for json files 7 years ago
.gitignore a7e610cb3d chore: Rework folder structure in preparation for monorepo setup 7 years ago
CONTRIBUTING.md 5919ce67da docs: Add MIT license, expand readme 7 years ago
LICENSE 5919ce67da docs: Add MIT license, expand readme 7 years ago
README.md b0328a1058 docs: Update readme 7 years ago
graphql.config.json 07a5d0aa8c feat: Set up Angular CLI project for admin-ui 7 years ago
tslint.json 9d6f45522b style: Unify tslint configs and fix outstanding issues 7 years ago

README.md

Vendure

logo

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

License

MIT