README.md

API - ZV

Warning: This project is not currently in use and is used for research purposes.

Table of Contents

• API - ZV
  • Table of Contents
  • Development
  • Running
    • Docker Compose
    • Local
      • Navigate to Source Dir
      • Install Dependencies
      • Run the Mongo Daemon
      • Run the ZV API Project

Development

This project uses Loopback3 for development. Loopback allows you to generate web services with ease. This project tries to have parity with the features on the Borzoo project.

Frontend services and models are created with the Loopback SDK Builder.

To regenerate the frontend services and models, use npm run build:sdk.

Running

Docker Compose

This project is setup with Docker Compose. Run docker-compose up in the same directory as the docker-compose.yml to run mongo and the project.

Local

If you do not wish to use Docker, you may run the project locally with the following steps:

Navigate to Source Dir

$ cd zv-api

Install Dependencies

$ npm i

Run the Mongo Daemon

Note: If you do not have Mongo installed, download it here.

$ mongod

Run the ZV API Project

$ npm start