diff options
| -rw-r--r-- | mobile/README.md | 31 | ||||
| -rw-r--r-- | web/README.md | 20 | ||||
| -rw-r--r-- | web/app.js | 2 |
3 files changed, 41 insertions, 12 deletions
diff --git a/mobile/README.md b/mobile/README.md new file mode 100644 index 0000000..5517dd1 --- /dev/null +++ b/mobile/README.md @@ -0,0 +1,31 @@ +# The Mobile Component + +## Installation + +### Requirements + +1. npm +2. Mobile emulator or real a device with Expo Client [Android](https://play.google.com/store/apps/details?id=host.exp.exponent&referrer=www), [iOS](https://itunes.apple.com/app/apple-store/id982107779) installed + +### Steps + +1. From this directory: + + `npm install` + + `npm start` + + This should open your browser to a page on localhost created by Expo with a QR code. + +2. Open the Expo Client and scan the QR code from the browser. The app now build on the device. + +> Note: If you want to connect to the Web Component from the mobile, you need to have the Web Component running simultaneously on localhost. Then you need to update the ip address found in app.json under "apiUrl" under "dev" to your local ip. Leave the port and remainder url as is. + +## Latest Production build (master branch) + +https://expo.io/@csc301dreamteam/helpthehome?release-channel=prod + +## Latest QA build (qa branch) + +https://expo.io/@csc301dreamteam/helpthehome?release-channel=staging + 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/ @@ -25,8 +25,6 @@ var env = process.env.NODE_ENV || 'development'; var uri; if (env === 'development') { uri = 'mongodb://localhost:27017/helpthehome' - // use for small testing only if really necessary - // uri = 'mongodb+srv://development:dreamteam@cluster0-krnr4.mongodb.net/helpthehome_devel?retryWrites=true' } else { // for qa and production set it on heroku config vars uri = process.env.MONGODB_URI |