From f12cfd263d622f8e424f3fff4a41f1d54491b278 Mon Sep 17 00:00:00 2001 From: Kevin Heffernan Date: Fri, 14 Sep 2018 11:28:25 -0700 Subject: [PATCH 1/7] Update README.md --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b689778..833db0d 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,15 @@ If you have a code from someone who has made an alarm then click on "Join Alarm" Then, input the unique key given to you. ( i.e. 8914223145) # How to Run Source Code: Set up Database through MongoDB -# 1. Creating environment variables locally +# 1. MLab Account + + Create a free mLab account at mLab.com + Create a new deployment with any hosting service + Click on your new deployment + Go the users tab and make a new user + Take note of the user credentials your just made, your db name, and host + +# 2. Creating environment variables locally Since we're going to be logging into a remote database, we have to hide our login credentials from the outside world. To do this, we're going to make a ```.env``` file inside our project directory. It should have a structure similar to this. ``` USER_= @@ -28,7 +36,7 @@ Make sure to run the following to add ```.env``` to your .gitignore! This way ou ``` echo ".env" >> .gitignore ``` -# 2. Additions to pom.xml +# 3. Additions to pom.xml If you forked the project, you must add the following lines to your pom.xml inside the `````` tag. ```XML From 5ba19b007ae822b07727d65459bce2fe4f602246 Mon Sep 17 00:00:00 2001 From: Kevin Heffernan Date: Fri, 14 Sep 2018 11:41:04 -0700 Subject: [PATCH 2/7] Update README.md --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1fbbddf..3d737d4 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,17 @@ If you have a code from someone who has made an alarm then click on "Join Alarm" Then, input the unique key given to you. ( i.e. 8914223145) # How to Run Source Code: Set up Database through MongoDB -# 1. MLab Account +# 1. Set up MLab Account - Create a free mLab account at mLab.com - Create a new deployment with any hosting service - Click on your new deployment - Go the users tab and make a new user - Take note of the user credentials your just made, your db name, and host +- Create a free mLab account at [mLab.com](https://mlab.com) +- Create a new deployment with any hosting service +- Click on your new deployment +- Go the users tab and make a new user +- Take note of the user credentials your just made, your db name, and host + +``` +mongodb://:@d/ +``` # 2. Creating environment variables locally Since we're going to be logging into a remote database, we have to hide our login credentials from the outside world. To do this, we're going to make a ```.env``` file inside our project directory. It should have a structure similar to this. From 8305133090e8695fcf80c5b3bddf12010d61d6b6 Mon Sep 17 00:00:00 2001 From: Kevin Heffernan Date: Fri, 14 Sep 2018 11:59:29 -0700 Subject: [PATCH 3/7] Add explicit instructions for env.sh --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3d737d4..5ae1901 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,11 @@ mongodb://:@d/ # 2. Creating environment variables locally Since we're going to be logging into a remote database, we have to hide our login credentials from the outside world. To do this, we're going to make a ```.env``` file inside our project directory. It should have a structure similar to this. ``` -USER_= -PASS_= -DB_NAME_= -HOST_= // should be something with mlab in it... +export MONGODB_USER= (for example: JohnKennedy) +export MONGODB_PASS= (for example: 1243541f) +export MONGODB_NAME= (for example: alarm) +export MONGODB_HOST= (for example: ds027583.mlab.com) +export MONGODB_PORT= (for example: 27583) ``` __!!! IMPORTANT !!!__ Make sure to run the following to add ```.env``` to your .gitignore! This way our secret credentials won't be pushed into our GitHub repos. From ad79b044d619f0f1ea151a0f9de0342fa8e2e3dd Mon Sep 17 00:00:00 2001 From: yingchao-zhu Date: Fri, 14 Sep 2018 12:24:03 -0700 Subject: [PATCH 4/7] Update README.md --- cs56/m18/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/cs56/m18/README.md b/cs56/m18/README.md index a91ff6b..2258d99 100644 --- a/cs56/m18/README.md +++ b/cs56/m18/README.md @@ -8,3 +8,13 @@ Yingchao, Kevin, Zheren, Seaky, Shiheng, Zhiqin 2. Respect privacy 3. Organize ourselves 4. Everyone particiates + +# M18 final remarks +See the README.md under ucsb-cs56-gauchoalarm and ISSUES + +More to implement: +Map: show the location of meeting +Phone Alarm: set the alarm in "clock" application on the phone + +Advice on working with the code: +w3schools.com is a good tool for writing html From 4e00746ab15716cf5030c5ad757d3942acb899ae Mon Sep 17 00:00:00 2001 From: yingchao-zhu Date: Fri, 14 Sep 2018 12:24:29 -0700 Subject: [PATCH 5/7] Update README.md --- cs56/m18/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/cs56/m18/README.md b/cs56/m18/README.md index 2258d99..6070189 100644 --- a/cs56/m18/README.md +++ b/cs56/m18/README.md @@ -13,8 +13,8 @@ Yingchao, Kevin, Zheren, Seaky, Shiheng, Zhiqin See the README.md under ucsb-cs56-gauchoalarm and ISSUES More to implement: -Map: show the location of meeting -Phone Alarm: set the alarm in "clock" application on the phone +- Map: show the location of meeting +- Phone Alarm: set the alarm in "clock" application on the phone Advice on working with the code: -w3schools.com is a good tool for writing html +- w3schools.com is a good tool for writing html From c121e5ac4ec854c78fcf0122a90c0dff552b7d09 Mon Sep 17 00:00:00 2001 From: yingchao-zhu Date: Fri, 14 Sep 2018 12:25:27 -0700 Subject: [PATCH 6/7] Update README.md --- cs56/m18/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/cs56/m18/README.md b/cs56/m18/README.md index 6070189..e9a7a9a 100644 --- a/cs56/m18/README.md +++ b/cs56/m18/README.md @@ -17,4 +17,5 @@ More to implement: - Phone Alarm: set the alarm in "clock" application on the phone Advice on working with the code: -- w3schools.com is a good tool for writing html +- www.w3schools.com is a good tool for writing html +- github.com/spullara/mustache.java From fdc05d42bb7c8b203b2db1a610b534f2c9246226 Mon Sep 17 00:00:00 2001 From: Zheren Dong Date: Fri, 14 Sep 2018 12:27:54 -0700 Subject: [PATCH 7/7] Update README.md --- cs56/m18/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/cs56/m18/README.md b/cs56/m18/README.md index e9a7a9a..bc00827 100644 --- a/cs56/m18/README.md +++ b/cs56/m18/README.md @@ -2,7 +2,7 @@ Yingchao, Kevin, Zheren, Seaky, Shiheng, Zhiqin -# Aggrements: +# Agreements: 1. Help each other 2. Respect privacy @@ -11,10 +11,18 @@ Yingchao, Kevin, Zheren, Seaky, Shiheng, Zhiqin # M18 final remarks See the README.md under ucsb-cs56-gauchoalarm and ISSUES +Potential of this project: GauchoAlarm looks simple and easy but actually it has much potential to be improved. +e.g. +From the aspect of development, it is a good idea to have a mechanicam of sleep&wakeup. We can use format method to make the program recognize the string of time and use heroku clock processes to make itself sleeping and wake up itself before the next alarm. + +From the aspect of users, we can offers sharing features after creating alarm and joinning alarm. More to implement: +- Sleep and Wakeup +- Sharing alarm - Map: show the location of meeting - Phone Alarm: set the alarm in "clock" application on the phone +- ... Advice on working with the code: - www.w3schools.com is a good tool for writing html