Skip to content

Latest commit

 

History

History
61 lines (35 loc) · 2.46 KB

README.md

File metadata and controls

61 lines (35 loc) · 2.46 KB
Raw

Georef

A user-friendly webapp for converting normal images into georeferenced ones.

Demo

Deploying

This requires [Docker] (https://www.docker.com/products/docker-engine) and [Docker Machine] (https://www.docker.com/products/docker-machine). You will also need to clone this repository.

If you are deploying locally and you are not running Linux you will need to create a virtual machine. This requires [Virtualbox] (https://www.virtualbox.org/). We are going to be using port 3030 to access Georef, so that needs to be exposed too. This can be done as so:

$ docker-machine create -d virtualbox georef
$ eval "$(docker-machine env georef)"
$ VBoxManage controlvm georef natpf1 'georef,tcp,,3030,,3030'

Alternately, if you are deploying to AWS, you will need to create an EC2 machine instead:

$ docker-machine create -d amazonec2 \
    --amazonec2-region 'eu-west-1' \
    --amazonec2-instance-type 't2.nano' \
    georef
$ eval "$(docker-machine env georef)"

(You will also need to expose port 3030 via the AWS Console.)

Create a configuration file, by copying config.example.json to config.json. See below for what values can be configured.

Next, build and run the Dockerfile:

$ docker build -t georef .
$ docker run --name georef -dp 3030:3030 georef

Georef should now be available on port 3030 of your machine.

Integration

Georef was built to be integrated as part of another application -- though it can be used on its own too. Integrate it with the rest of your application by using the following configuration options:

output: one of 'geotiff' or 'tiles' to either produce a single GeoTiff image, or a Zip file containing map tiles in XYZ format.

uploadLocation: a Url. If present and Georef is called with an id parameter the resulting image data gets uploaded here as a HTTP POST, with the id parameter concatenated onto the end. If both this configuration option is set and a an id is present the download button at the end is not shown.

nextLocation: a Url. If present and the resulting image is to be uploaded, the user is redirected here after georeferencing. If present but the image is not to be uploaded a 'Next' button is shown on the download screen to take the user there.

Testing

Install the development dependencies:

$ npm install --dev

Then run the tests:

$ npm test