ZFR Instructions - swansond/LavatoryLocator GitHub Wiki

GitHub, Phabricator general setup

The two repositories are this one (swansond/LavatoryLocator) and the backend/website one at swansond/LavatoryLocatorDB. The wiki for this project is contained entirely on the primary repository's page. Any wiki comments on the DB repo are solely reminders to the developers. Both repositories are public, and should be easily accessed by anyone attempting to grade us. We are using GitHub's issue tracking and pull requests instead of using Phabricator. General issues can be directed to the PM, David Jung, while access issues of any sort can be directed to David Swanson.

Bug-tracking setup

We use the GitHub issues and pull request system to handle bugs. Each developer currently has an issue assigned with their task for this week. When a bug is discovered, a new issue is created (or it is added to an existing issue). Pull requests are evaluated by whoever can look over the code next. Comments are made about anything noticed regarding style, programming practices, or other issues, and if the OK is given, the pull is completed. Development of each feature occurs on its own feature branch, which is then added to the master upon completion. Bug tracking occurs at each step, on a group level for the branch and a team level for the pulling.

Source control and build process instructions

This repository hosts the code necessary to build the application. Currently, the .apk file is available on our website, lavlocdb.herokuapp.com.
To build and run the application:

  1. Clone the repository to your local machine.
  2. Import the project into your Eclipse workspace.
  3. In Android, navigate to the LavatoryLocator/src/edu.washington.cs.lavatorylocator/MainActivity.java file and "Run" (Eclipse command) the file.
  4. Given that your Eclipse workspace has a working Android Virtual Device, the application should run.

Data access instructions

We are using a database stored on the Heroku server for this project. Going the url http://lavlocdb.herokuapp.com/test.php will perform the query "select * from team" on our database. The url http://lavlocdb.herokuapp.com/queryrunner.php allows you to write your own queries. This functionality will be removed/hidden when real data is entered into the database. Some tables you can access are "team" and "bathroom". A cursory glance at queryrunner.php and test.php in the repository (LavatoryLocatorDB) will show that an actual query is taking place. The output of any of these queries is a JSON to be parsed by our application.
I suggest running the query "insert into team values ('_____', '____')" followed by "select * from team" to view the functionality.