nicholaspretorius/wakemaps.api

Flask, Postgres API running in Docker.

Python

Running the app

Local Computer:

export FLASK_APP=project/__init__.py; python manage.py run

Docker Container:

Development:

docker-compose build - to build the images
docker-compose up - to start the containers
docker-compose down - to stop the containers
docker-compose down -v - to stop the containers and take down the volume

When running for the first time, (or anytime the volumes are taken down), run:

docker-compose exec web python manage.py seed_db

This will seed the db with some basic data.

To connect to the database and check the contents:

docker-compose exec db psql --username=username_goes_here
\l - lists all the databases
\c wakemaps_dev - connect to the wakemaps_dev database
\d - to view the tables
\dt - to view the schema
SELECT * FROM wakeparks; - to see what is in the table

To verify the volume is created run:

docker volume inspect wakemaps.api_postgres_data

Tests:

python -m pytest services/web/project/test.py

Production:

docker-compose -f docker-compose.prod.yml build
docker-compose -f docker-compose.prod.yml up
docker-compose -f docker-compose.prod.yml down -v

If this is the first time you are running this, you will need to:

docker-compose exec web python manage.py create_db
docker-compose exec web python manage.py seed_db - if these is no data
docker-compose exec db psql --username=username_goes_here --dbname=database_name_goes_here