1 files changed, 31 insertions, 0 deletions
diff --git a/web/README.md b/web/README.md
new file mode 100644
index 0000000..d44fd9b
--- /dev/null
+++ b/web/README.md
@@ -0,0 +1,31 @@
+# The web component
+
+## How to run in your local env:
+
+### Requirements
+1. docker (or local mongodb install)
+2. npm
+
+#### Steps
+
+1. Spawn up a docker container with mongodb
+`docker run -d --name mymongo -p 27017:27017 mongo`
+2. enter inside the container:
+`docker exec -it mymongo mongo`
+3. run inside the interactive mongo shell:
+`use helpthehome`
+4. Now you are ready to start the app:
+From this directory:
+`npm install`
+`npm start`
+Then open your browser to `localhost:3000`
+
+You should be greeted with a page with a map.
+
+## You can view the current latest production site on Heroku (master branch)
+
+[here]()
+
+## You can view the current latest QA site on Heroku (qa branch)
+
+[here]()