Skip to content

0. Getting Started

Jump to bottom
Nick Holbrook edited this page Feb 28, 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

To deploy changes to the server, simply merge a GitHub PR into the main branch of this repo. Custom github actions will take care of updating any changes to the Terraform infrastructure / API source code.

More information regarding this process will be added at a later date.

Third-Party Dependencies (python packages)

  • TODO
Clone this wiki locally