Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 1.05 KB

README.md

File metadata and controls

23 lines (15 loc) · 1.05 KB

WolfBeacon Core API

The Core WolfBeacon API for authenticated mobile and web clients providing primary organisational and retrieval services.

Written in ES6+, API Powered by Node/Express/Mongoose/Joi, authentication by Auth0, transpiled by Babel and Documentation generated by ApiDoc.

API Documentation

Find the documentation at https://wolfbeacon.com/core-api-docs

Local Setup:

Dependencies: npm

  • npm install
  • Create the .env file and enter the MONGODB_URI
  • npm start
  • Alternatively, to use nodemon, install it using npm install -g nodemon and run as npm test

Running/Deploying with Docker

  • docker service start #sudo
  • docker build -t wolfbeacon-core-api . #sudo
  • docker run docker run wolfbeacon-core-api #sudo