https://github.com/f2prateek/cmput-275-project

https://github.com/f2prateek/cmput-275-project

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/f2prateek/cmput-275-project
• Owner: f2prateek
• Created: 2014-04-02T16:23:53.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-04-11T03:58:34.000Z (over 10 years ago)
• Last Synced: 2023-03-24T08:21:46.518Z (over 1 year ago)
• Language: Python
• Homepage: https://vast-lowlands-8551.herokuapp.com
• Size: 3.81 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Router

By Prateek Srivastava and David Woodruff

##### *Live at https://vast-lowlands-8551.herokuapp.com*

##### *Download Android App at http://cl.ly/2O0c141M3x05*

Router is a web app that will display a map of venues from Foursquare closest to the user.

Users can see a quick overview of the venues, with information such as location (from the map),

number of users at a particular venue, and number of tips left by the other users for the location.

Users can also specify a search term to look for specific venues, e.g. 'cupcake'. If you don't want to specify a

search query, simply click on your marker to load nearby locations.

From the map, users can select an arbitrary number of points and the app will find a route to travel

through all the selected points (starting from the user's location). Tapping a location turns it dark blue (indicating

it is selected, tapping it again turns it back to it's original color). Click on the route button to load the next page.

The app will try to optimise the path to minimize travel distances.

It will use a greedy algorithm to compute the route, which is faster than other solutions but does not guarantee optimality.

Note that paths are minified, i.e. only points in which user has to change direction are returned.

The app also exposes a RESTful API that other clients can use. The included Android client uses this to (mostly) replicate

the website's functionality.

# Setup

## Server

### Install Python v2.7.6

https://www.python.org/downloads/

### Install pip

Save https://raw.github.com/pypa/pip/master/contrib/get-pip.py

Run `python get-pip.py`

### Create a Virtual Environment

This is optional, but recommended.

`virtualenv venv`

`source venv/bin/activate`

### Install depdencies

`pip install -r requirements.txt`

### Start server

`python server.py`

For future invocations, just execute the bundled `run.sh` file

### Deploy to heroku

From the root of the project, run `git subtree push --prefix server heroku master`

With my credentials, the app is accessible at https://vast-lowlands-8551.herokuapp.com

## Android Client

### Install JDK

http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-138363.html

### Install Android SDK and dependencies

https://developer.android.com/tools/index.html

### Setup Android Map SDK

Speicifically, setup the signing key for maps

https://developers.google.com/maps/documentation/android/

### Build and Install

run `./gradlew clean build installDebug`