GeositeFramework

A Javascript framework for hosting map tool plugins. Developed to support the Coastal Resilience suite of tools.

Coastal Resilience is a program of The Nature Conservancy that supports a community of practitioners around the world who are applying planning innovations, the web-based mapping tool framework and individual Coastal Resilience “apps” or plugins to the framework to coastal hazards and adaptation issues.

Copyright (C) 2019 The Nature Conservancy

Developing

To run the project locally, on any OS, clone the repo and ensure you have Python 2.x. You can choose to work on your host machine or within a docker container. It is advised to work within docker if you'd rather not adjust your local python setup.

Running the development environment on your host

Ensure pip is installed.

Install the python requirements:

python ./scripts/update.py

Run the development server and serve the static assets:

python ./scripts/server.py

Running the development environment through Docker

Ensure docker and docker-compose are installed and that the docker client is running.

The same commands as above will run within docker if passed a docker flag, -d:

Build the docker container with dependencies installed and serve the static assets:

python ./scripts/server.py -d

If requirements should change, dependencies can be updated via script:

python ./scripts/update.py -d

Containers can be accessed by bash in the usual way:

docker-compose exec <container_name> /bin/bash

To stop the docker server:

docker-compose stop server

Ports

Scripts

Prefix script calls with python, if python is not in your $PATH.