Merge pull request #13 from TaskarCenterAtUW/onboarding-john-bee

Adding section to README for local development

Author: jeffmaki

README.md

@@ -30,7 +30,7 @@ See GitHub's actions tab in this repo for more deployment examples/steps.
 
 # Getting Started
 
-### To build images
+### To build images for deploy
 
 ```git clone --recursive https://github.com/TaskarCenterAtUW/workspaces-stack.git```
 
@@ -49,5 +49,50 @@ Replace XXX.env with the environment definition file of the environment for whic
 ### Other Files
 
 * ```example.env```: template of the .env file required by the Docker compose YAML files
-* ```tdei_uw.env```: .env for deployment at UW's TDEI center. Only UW should use this, new users should adapt example.env to suit their needs. LTG: remove this file from this repo. 
+* ```tdei_uw.env```: .env for deployment at UW's TDEI center. Only UW should use this, new users should adapt example.env to suit their needs. LTG: remove this file from this repo.
 
+# Local Development
+
+### To build images for local development
+
+You will need access to prepopulated .env files that are not in version control.  Specifically local.dev.env for the rest of these steps, which is assumed to be found in the workspaces-stack root directory.
+
+Add (or merge) the following to your ```/etc/hosts``` file:
+```127.0.0.1	localhost workspaces.local api.workspaces.local rapid.workspaces.local osm.workspaces.local pathways.workspaces.local tasks.workspaces.local```
+
+You will also need to increase the total amount of system memory available to Docker containers to 10+ GB.  In Docker Desktop you find this in Settings -> Resources -> Memory Limit.
+
+```git clone --recursive https://github.com/TaskarCenterAtUW/workspaces-stack.git```
+
+Comment out the ```osm-log-proxy``` section from ```docker-compose.yml``` as aggregate logging is not available locally.
+
+```docker-compose build```
+
+```cp local.dev.env .env```
+
+```docker-compose up -d```
+
+Now we are ready to finalize configuration on each container.
+
+```docker-compose run --rm --entrypoint=bash frontend```
+```npm i```
+```exit```
+
+```docker-compose run --rm --entrypoint=bash rapid```
+```npm i```
+```exit```
+
+```docker-compose run --rm --entrypoint=bash pathways-editor```
+```npm i```
+```exit```
+
+```docker-compose run --rm --entrypoint=bash osm-rails```
+```cp /config/example.storage.yml /config/storage.yml```
+```bundle install```
+```exit```
+
+Note that there are two different ways to run individual containers depending on your dev context.
+
+Using the frontend container as an example:
+* To debug / step through run ```docker-compose run --rm frontend```
+* To run while working on another service run ```docker-compose up -d frontend```