Dumpstermap Backend

Dumpstermap.org is a collaborative world wide map to share dumpster locations for others to find.

Built with

Backend

• Python, Django, Django REST framework (with geospatial add-ons)
• PostgreSQL, PostGIS, Docker
• Deployed to Heroku

Frontend

• TypeScript, Angular, Leaflet
• Deployed to Vercel

➡️ Frontend Repository

Development setup

Prerequisites

The development setup requires:

• Python 3.10
• pipenv
• Geospatial libraries required by GeoDjango
• Docker to run a Postgres database with GIS extension.

To install the required python version and all python dependencies, run:

pipenv install

Database

In order to start a basic docker container capable of serving a PostGIS-enabled database (with postgres as default user and database), run:

 docker run -p 5432:5432 --name some-postgis -e POSTGRES_PASSWORD=mysecretpassword -d postgis/postgis

Configuration

The application can be configured using environment variables or a .env file. See local.env.sample for all required and optional variables.

Migrate database

Run manage.py migrate to create all database tables.

Development server

Run manage.py runserver for a dev server.

Running tests

Run pipenv run pytest to execute the unit tests.

Deployment

License

tbd