V1 Documentation - swansond/LavatoryLocator GitHub Wiki

Quick Use (on Eclipse)

  1. Clone our repository: git clone [email protected]:swansond/LavatoryLocator.git
  2. In Eclipse, navigate to File->Import...
  3. Navigate to Android->Existing Android Code Into Workspace, click Next
  4. Click Browse and select the LavatoryLocator directory (which was created during the clone)
  5. Four projects will show up: choose to import LavatoryLocator, actionbarsherlock, and google-play-services_lib (everything other than LavatoryLocatorTests) and click Finish.

Quick Use (on Android phone)

  1. Download our .apk file here
  2. Install the .apk
  3. Run the app.

Code Coverage Generation (with Android phone)

  1. In a terminal, navigate to LavatoryLocator -> LavatoryLocatorTests
  2. Run ant -Demma.filter="-com. -android" clean emma unittests
  3. Open coverage.html (or coverage.txt) in the bin directory.

Features Implemented

Exactly everything that was specified here, minus everything in the below section. To be more verbose, though:

  • User logins via Google+
  • Anonymous users ability to read data but not write to the database without logging in via Google+
  • Search for lavatories
  • Map view of lavatories and UW campus via Google Maps
  • List view of lavatories
  • Add, modify, delete lavatories: Users can request to add, modify, and delete lavatories.
  • Ratings: Users can rate lavatories.
  • Reviews: Along with ratings, users can submit a text review of a lavatory.
  • Review helpfulness: Users can mark reviews as helpful.

Features Not Implemented

  • Favorite Lavatories: After a talk with Jamie, we decided that we would not implement a list of favorites for lavatories. The main reason for this feature drop is that getting the Google+ account system implemented was taking longer than we thought, and we wanted to make sure that we had a working and polished user system before we implemented some minor feature that depended on it.
  • Reporting reviews: We decided that this wasn't core to our functionality, and we weren't sure what we'd do with a report if we got one.