Skip to content

0. Getting Started

Jump to bottom
David Sanabria edited this page Apr 19, 2022 · 24 revisions

Front End

Open Android Studio and click File -> Open then navigate to interesting-co/rememri and click OK.

Next, you must acquire an API key for Mapbox, that can be done here. Once you have a token, place it in rememri/app/src/main/res/values/strings.xml in mapbox_access_token.

Finally, to run the app, setup an emulator supporting Google Play APIs and running API 31. Then, select the device from the device dropdown at the top and click the green run button.

If you need help follow this guide

Note: to run the AR portion of our app, you require a capable android phone to view images in AR. A guide can be found here.

Front End Dependencies

  • Mapbox
    • We will be using Mapbox to manage pins on a 2D map.
  • ARCore
    • We will use ARCore to display images in the camera view using augmented reality.

Backend

  1. Clone the Github repo (git clone https://github.com/michigan224/Interesting-Co.git interesting-co )
  2. Open up a new bash terminal with backend as the current directory (cd interesting-co/backend)
  3. Initialize a python virtual environment (python3 -m venv env)
  4. Activate your python virtual environment (source env/bin/activate)
  5. Install the necessary dependencies (pip install -r requirements.txt)
  6. Run the server (./run or FLASK_APP=app.py FLASK_ENV=development flask run) A copy of the server should now be running locally at localhost:5000.

Server Deployment

The server is currently hosted at https://rememri-instance-5obwaiol5q-ue.a.run.app

To deploy any changes to the hosted server:

  • navigate to the backend folder (cd interesting-co/backend)
  • deploy a Cloud Run build (gcloud builds submit)

Note: To deploy these changes, you must have gclouds CLI tool set up and working properly. You must also have a key.json file containing the credentials for Firebase.

You can follow this guide to set it up from scratch.

Backend Dependencies

Python Packages

  • geopy
    • We will be using the GeoPy API to calculate distances between points.
  • flask
    • Flask will be used to handle the REST API.
  • firebase_admin
    • Library to connect to the firebase database.
  • PyJWT
    • We will use JWT to handle generating and authenticating tokens.

Our backend will be built by us as described in section 2. APIs and Controller

Clone this wiki locally