aboutsummaryrefslogtreecommitdiff
path: root/web/README.md
diff options
context:
space:
mode:
authorKumar Damani <kumar.damani@mail.utoronto.ca>2019-04-18 23:37:12 +0000
committerKumar Damani <kumar.damani@mail.utoronto.ca>2019-04-18 23:37:12 +0000
commit750db994aaba6af8205ce62d4e05de19aaa508f6 (patch)
tree86cddf17baa1934bb462eb2d035f5dac59d98c66 /web/README.md
parent5e4bcf6cf9aabe46d544db8c56f33fb08543cc49 (diff)
updated readmes, removed db url link
Diffstat (limited to 'web/README.md')
-rw-r--r--web/README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/web/README.md b/web/README.md
index b7f02b3..66790a1 100644
--- a/web/README.md
+++ b/web/README.md
@@ -1,20 +1,20 @@
-# The web component
+# The Web Component
-## How to run in your LOCAL env:
+## Installation
### Requirements
1. docker (or local mongodb install)
2. npm
-#### Steps
+### Steps
+> Docker steps below might not work on Windows. Refer to Docker docs.
-1. Spawn up a docker container with mongodb OR start mongo from local install
+1. Spawn up a docker container with mongodb OR start mongo from your local install
`docker run -d --name mymongo -p 27017:27017 mongo`
-
-2. Now you are ready to start the app:
+2. Now you are ready to start the web component:
From this directory:
@@ -24,13 +24,13 @@
Then open your browser to `localhost:3000`
-You should be greeted with a page with a map. From next time onwards, just start up the mongo container with `docker start mymongo`.
+You should be greeted with the home page. From next time onwards, just start up the mongo container with `docker start mymongo`.
-## You can view the current latest production site on Heroku (master branch)
+## Latest Production site (master branch)
-not yet.
+https://helpthehome-prod.herokuapp.com/
-## You can view the current latest QA site on Heroku (qa branch)
+## Latest QA site (qa branch)
https://helpthehome-qa.herokuapp.com/