Backend of COA

The flask backend REST APIs for the COA website.

Getting Started

1. Install the dependencies

sudo apt install python3.8
sudo python3.8 -m pip install pipenv

# Alternatively with docker
sudo apt install docker

2. Setup DB related environment variables (not posted here for security reasons).
3. Start the server

make run

# Alternatively with docker
make prod-run

Running the Backend

To test that the flask app is running and properly connected to the database, use the curl command.

# Local
curl localhost:5000/locations

# Prod
curl http://coa-flask-app-prod.us-east-1.elasticbeanstalk.com/locations

Inspecting the Database

1. Install MySQL Workbench here
2. In MySQL Workbench click on 'MySQL Connections +' to add a connection with AWS RDS.
3. Enter the hostname, port, username, and password using the same credentials mentioned in the CONTRIBUTING.md.
4. From the 'Home' view, you can click on the connection to inspect the database.