Skip to content
This repository has been archived by the owner on Apr 28, 2018. It is now read-only.
Michael Comella edited this page Aug 28, 2017 · 1 revision

Trying to compile Prox?

This is an inactive project so the core contributors have other priorities and can only provide minimal support. However, if you wish to try to compiling and running the project, you may follow guide written by mcomella for a developer below:

Unfortunately, it'd take too much time for me to create public API keys for you but I might be able to provide you with the tools to get the project compiling and running. Please note that this may be time consuming.

First, let's remove the dependency on Prox/Prox/APIKeys.plist:

  1. Remove the code that references the keys from the API keys file. Here's a sample APIKeys.plist file with the keys you need to address.
  2. Then remove the APIKeys.plist file from the Xcode project.

Then we need to create an account to get the keys for GoogleService-Info.plist:

  1. Create a firebase account
  2. Add the iOS keys for Firebase Remote Config and Firebase Database to the project. The Firebase website should give you steps to download a GoogleService-Info.plist and you can place it in the appropriate directory of the project, Prox/Prox/GoogleService-Info.plist.

As far as I know, the app should now compile and run. However, without database data, it won't be very useful. As such, you'll need to fill the database with some dummy (or real) data. Notes:

  • This is the part that I expect to take a long time
  • The data is place data (ratings, reviews, images, etc.) for things to do, restaurants, etc.
  • The real data was provided from accessing the Yelp API. We used some scripts from the prox-server repository to do this but unfortunately, I can't remember which ones!
  • We had multiple versions of the app: one that used the user's current location and one that was fixed in Chicago. By default, I think we build with the user's current location (which would then be where you'd want to add the dummy data) but I'm not sure.
  • We may filter our places based on criteria (e.g. place rating, what kind of data we have for said place) so even if you include dummy data, it may get filtered out until you meet all the criteria (unless you remove that code! here?)

iirc, by default, all data will be read in your Firebase Database from the path /users//venues/. There are two necessary subhierarchies:

There's a third hierarchy that I don't think is necessary (we used it for adding items to the DB) but it's status/ just in case. Here's the sample data.

I hope that's enough to go on - good luck!

Clone this wiki locally