README.md

nyw_web_api

NYwater.info Express.Js API Server

This repository maintains all the source code for the server-side application running at NYwater.info.

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 nyw_data

Run the server

npm start

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