Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated README.md and cs56/m18/README.md #22

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,33 @@ 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. Set up MLab Account

- 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://<dbuser>:<dbpassword>@d<dbhost>/<dbname>
```

# 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_=<your user's username>
PASS_=<your user's password>
DB_NAME_=<your db name>
HOST_=<your host name> // should be something with mlab in it...
export MONGODB_USER= <your user here> (for example: JohnKennedy)
export MONGODB_PASS=<your pass here> (for example: 1243541f)
export MONGODB_NAME=<your database name here> (for example: alarm)
export MONGODB_HOST=<your host here> (for example: ds027583.mlab.com)
export MONGODB_PORT=<your port here> (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.
```
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 ```<dependencies>``` tag.
```XML
<!-- MongoDB NoSQL Database -->
Expand Down
21 changes: 20 additions & 1 deletion cs56/m18/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,28 @@

Yingchao, Kevin, Zheren, Seaky, Shiheng, Zhiqin

# Aggrements:
# Agreements:

1. Help each other
2. Respect privacy
3. Organize ourselves
4. Everyone particiates

# 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
- github.com/spullara/mustache.java