map-search

Dependencies

docker, docker-compose

Initial setup

Setting up the Docker Compose environment

$ cd /path/to/project

$ cp -r sample/env .env

Change the credentials in .env/db.env and .env/django.env to something secure

$ docker compose up -d

NOTE: Add --build if you want to build the image from source

Setting up the database

Either:

$ docker compose exec web python manage.py migrate

to start off with an empty user database

or

$ cat sample/db.sql | docker compose exec -T db psql -U postgres -d postgres

to restore the included sample database

NOTE: If you have changed DATABASE_DB and/or DATABASE_USER in .env/db.env then the above command will have to be modified to reflect that

Usage

Navigate to http://localhost:8000/api/docs to experiment with the API

Testing

$ docker compose run --rm --build web python manage.py test

Verify GameFuzzy/map-search image build provenance

$ gh attestation verify oci://index.docker.io/gamefuzzy/map-search -R GameFuzzy/map-search