diff options
Diffstat (limited to 'web/README.md')
| -rw-r--r-- | web/README.md | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/web/README.md b/web/README.md index b7f02b3..622751d 100644 --- a/web/README.md +++ b/web/README.md @@ -1,20 +1,21 @@ -# 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 -1. Spawn up a docker container with mongodb OR start mongo from local install +> Docker steps below might not work on Windows. Refer to Docker docs. - `docker run -d --name mymongo -p 27017:27017 mongo` +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 +25,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/ |