diff options
| author | Kumar Damani <damani.kumar@gmail.com> | 2019-04-18 23:38:26 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-04-18 23:38:26 +0000 |
| commit | 2556455ab286d7ceb5cefbb081cc8e2c6ca5cb73 (patch) | |
| tree | 8a93fd4d774c3d42abc404213ef565531350398b /web/README.md | |
| parent | 52ce47b39b053934189120d5c0686f9c8a71b29a (diff) | |
| parent | 750db994aaba6af8205ce62d4e05de19aaa508f6 (diff) | |
Merge pull request #73 from csc301-winter-2019/web-homepage
updated readmes, removed db url link
Diffstat (limited to 'web/README.md')
| -rw-r--r-- | web/README.md | 20 |
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/ |