README.md

nywater.info

Production deployment and documentation for NyWater.info

This repository includes git submodules for the following repositories:

• nyw_data | README

• nyw_web_client | README

• nyw_web_api | README

Each repository maintains its own README.md and deployment instructions - please consult each individual repository for development and deploy instructions.

Updating submodules

1. Run sh update.sh - this will pull the latest changes for each repository. Commit and merge the changes to this repository (nywater.info).

Deployment

These are the instructions to deploy the entire NyWater.info stack. We assume basic knowledge of server provisioning and dependency installation.

1. Provision a server (we use DigitalOcean) running Ubuntu at version 16.04 with the following:

   • Docker
   • Node.js
   • npm
   • nginx

2. Run the deploy instructions in the following submodules (order-specific)

   • nyw_data
   • nyw_web_api
   • nyw_web_client

3. Copy the client build to /www with the following commands:

   • cp ~/nyw_deploy/nyw_web_client/dist/index.html /www/index.html
   • cp -R ~/nyw_deploy/nyw_web_client/dist/static /www/

4. Copy nywater.info.NGINX to /etc/nginx/sites-enabled/nywater.info

5. Run sudo service restart nginx

Documentation

• API documentation is available at nywater.info/docs