Osmaxx

Short project name for "OpenStreetMap arbitrary excerpt export".

Cuts out OpenStreetMap data, processes it to geodata and converts it to typical GIS fileformats before being prepared for download.

Website: http://osmaxx.hsr.ch/

Development

• Project Repository (Git)
• Project Development Environment (Docker)
• Commonly used commands for development
• Deployment

We do not recommend to run the application local on your machine but it's possible. We recommend to use the development docker containers.

NOTE: to run it locally (no docker), you might want to copy the .env-dist to .env and adapt the lines there.

Run it locally on Linux

Prerequisites

To run this project locally, you need docker and docker-compose installed (https://docs.docker.com/installation/ubuntulinux/ and https://docs.docker.com/compose/install/).

Initialization

# For development:
ln -s compose-development.yml docker-compose.yml

# For production:
ln -s compose-production.yml docker-compose.yml

Docker container bootstrapping

Take a look at the scripts setup.development.sh and ```setup.production.sh``. These scripts will setup the container forest, run migrations and create a superuser (interactive).

To setup all the containers and their dependencies by hand, run

docker-compose build

Then initiate the project defaults by running the following command:

# For development:
docker-compose up -d databasedev;
docker-compose run webappdev /bin/bash -c './manage.py migrate && ./manage.py createsuperuser'

# For production:
docker-compose up -d database;
docker-compose run webapp /bin/bash -c './manage.py migrate && ./manage.py createsuperuser'

Alternative to this command, bootstrap the container and execute the commands inside the container by hand:

# For development:
docker-compose up -d databasedev
docker-compose run webappdev /bin/bash

# For production:
docker-compose up -d database
docker-compose run webapp /bin/bash

Inside the container:

1. Execute migrations: $ ./manage.py migrate
2. (optional, recommended) setup a superuser: $ ./manage.py createsuperuser

Running the project

Start the containers using docker compose:

docker-compose up

Documentation

See Wiki: https://github.com/geometalab/osmaxx/wiki

Problems & Solutions

Leaflet is missing

You forgot to pull the submodules

ProgrammingError at /login/

relation "django_site" does not exist
LINE 1: ..."django_site"."domain", "django_site"."name" FROM "django_si...

You forgot to run the migrations

Tests failed, but worked before with no apparent change

Do not run docker-compose build --no-cache. Use docker-compose rm -f && docker-compose build, or if you really want to start clean, remove all docker containers

docker rm -f $(docker ps -q)

and remove all images

docker rmi -f $(docker images -q)

WARNING: This removes all containers/images on the machine.