From 085538ec47cb5baa29c4214d97c6926b285ab507 Mon Sep 17 00:00:00 2001 From: Kumar Damani Date: Sun, 17 Feb 2019 21:15:36 -0700 Subject: added basic site with basic map --- web/README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 web/README.md (limited to 'web/README.md') 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]() -- cgit v1.2.3 From 0022b41b5a1d20c60d9ffb56403150ce97153f09 Mon Sep 17 00:00:00 2001 From: Kumar Damani Date: Sun, 17 Feb 2019 21:20:56 -0700 Subject: fixed README --- web/README.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) (limited to 'web/README.md') diff --git a/web/README.md b/web/README.md index d44fd9b..244c216 100644 --- a/web/README.md +++ b/web/README.md @@ -9,16 +9,26 @@ #### Steps 1. Spawn up a docker container with mongodb -`docker run -d --name mymongo -p 27017:27017 mongo` + + `docker run -d --name mymongo -p 27017:27017 mongo` + 2. enter inside the container: -`docker exec -it mymongo mongo` + + `docker exec -it mymongo mongo` + 3. run inside the interactive mongo shell: -`use helpthehome` + + `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` + + From this directory: + + `npm install` + + `npm start` + + Then open your browser to `localhost:3000` You should be greeted with a page with a map. @@ -29,3 +39,4 @@ You should be greeted with a page with a map. ## You can view the current latest QA site on Heroku (qa branch) [here]() + -- cgit v1.2.3 From 35818d32e197903bf314fafe6231f948de6149dd Mon Sep 17 00:00:00 2001 From: Kumar Damani Date: Sun, 17 Feb 2019 22:32:21 -0700 Subject: added check for envs and mongo uri, updated readme --- web/README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'web/README.md') diff --git a/web/README.md b/web/README.md index 244c216..b56efa5 100644 --- a/web/README.md +++ b/web/README.md @@ -1,14 +1,15 @@ # The web component -## How to run in your local env: +## 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 +1. Spawn up a docker container with mongodb OR start mongo from local install `docker run -d --name mymongo -p 27017:27017 mongo` @@ -30,13 +31,13 @@ Then open your browser to `localhost:3000` -You should be greeted with a page with a map. +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 can view the current latest production site on Heroku (master branch) -[here]() +not yet. ## You can view the current latest QA site on Heroku (qa branch) -[here]() +https://helpthehome-qa.herokuapp.com/ -- cgit v1.2.3