README.md

ir_web_api

InspectorRestaurant Express.Js API Server

This repository maintains all the source code for the server-side application running at Inspector.Restaurant.

Getting Started

Prerequisites

• Node.js 8.x.x
• npm 3.x

Installing & Configuration

1. Install dependencies

npm install

2. Run the docker-compose.yml file in ir_data

Run the server

npm start

Development

A Postman collection and environments (dev and production) are included in this repository to support API development - they are located in the .postman directory. Read the Postman documentation about importing collections and environments.

Documentation

Documentation is auto-generated from APIDoc.JS. Build the documentation with the npm run apidoc command. The hosted documentaton is available here.

License

MIT License.

Technologies used

• Express.js

• Mongoose

• dotenv

• APIDoc.JS