###Description Commutr is an intelligent commuting app that lets you know when to leave in order to get to work on time taking public transit. It leverages machine learning algorithms to learn your schedule. Commutr calculates when you need to be leaving, sends you a notification, and displays your suggested route.

###Technical Stack Commutr is a full stack app built in Angular and Ionic on the front end, Node.js, Express.js, and MongoDB on the back end. It leverages the Google Maps and Directions APIs. Cordova plugins give access to native Android features like geolocation and background notifications. Google OAuth 2.0 provides secure login.

###OAuth Login Google's OAuth 2.0 Login provides a secure way of authenticating users. Embedding the Google login button opens the authentication dialogue in a new browser window. In order to implement this feature in Ionic, we had to tap in to Cordova's InAppBrowser feature, which allowed us to direct the user through the login process, and extract the returned access token from the URL to which Google redirects the browser following a successful login. This technique enables a JavaScript web app authentication flow in a mobile environment.

###To Install

1. Make sure you have node.js installed, and run

   npm install -g bower
   

2. To build a working copy of the app, you will need to have the Android SDK installed, which requires the Java Development Kit.

3. Fork the repo, then

   git clone https://github.com/[YOUR USERNAME]/Commutr/
   

4. cd to the root of your repo, and

   npm install
   

5. cd to the client folder, and

   bower install
   

6. For development, run mongod from the root folder.

7. When you're ready to build, run gulp buildAnd

###File guide

1. Build tasks - /gulpfile.js
2. Client side logic - /client/www/js
3. HTML templates - /client/index.html - /client/www/templates
4. Server logic - /server

###Contributors Guide

1. Fork TransitPal/Commutr to contribute

2. Add upstream remote

   git remote add upstream https://github.com/TransitPal/Commutr.git
   

3. Before pushing to personal fork*:

   git pull --rebase upstream dev
   

4. Push to personal fork:

   git push origin master
   

5. Submit pull request to TransitPal/Commutr dev branch. Dev branch is used as a staging area for new features. Master branch will always be the official working release, as it is auto-deployed to commutr.azurewebsites.net.

* Rebase from upstream dev is also required after every new feature announcement

###Resolving Pull Requests

1. One team member (other than the contributor) will be selected to do a code review
2. Upon approval run these commands from the official clone:

   git checkout -b test-branch dev
   
   git pull [email protected]:<YOUR_REPO_URL> master
   
   git checkout dev
   
   git rebase test-branch
   
   git push origin master
   

###Style Guide

Keep all commits in present tense (e.g. 'implements', 'creates', 'adds').

Do not use a period at the end of commit messages.

Extensive style guide found here.