Skip to content

0. Getting Started

Jump to bottom
Nick Holbrook edited this page Mar 18, 2021 · 27 revisions

Front End

Third-Party Dependencies (CocoaPods packages)

Back End

Running Locally

Prerequisites

The following software is required to be installed locally to run the API

Once docker is installed, make sure you have cloned this Github repo locally. From the backend-api directory, run make local-start. This will start a local Postgres Database on localhost:5432, an Adminer console on localhost:8080 to manage the database, and the ARmaps api on localhost:5000.

Once changes are made to the code that you want to test, run make local-start to update and restart the API locally.

If you want to stop all locally running instances, run make local-clean.

Server Deployment

Our backend is managed via terraform. To deploy new changes, from the terraform directory, first run make init. This initializes a new terraform workspace on your computer. Then you can run make plan, which compares the actual resources in AWS to your local state and notifies you of what changes you would be making if you run make apply. Running make apply provisions / deletes all of the resources notified in the plan stage.

Third-Party Dependencies (python packages)

  • Flask==1.1.2
  • pathlib==1.0.1
  • psycopg2-binary==2.8.6
Clone this wiki locally