New MapRoulette

Version 2 of MapRoulette

Welcome to New MapRoulette, the powerful & popular bug fixing tool (or is it a game?) for OpenStreetMap.

This README deals with development related topics only. If you are interested in contributing to OpenStreetMap by fixing some bugs through MapRoulette, just head over to the MapRoulette web site and get started - it should be pretty self explanatory.

That said, read on if you want to contribute to MapRoulette development and are ready to deploy your local instance.

Contributing

Please fork the project and submit a pull request. See Postman Docs for information on API Testing.

Frameworks used

New MapRoulette is built upon the Play Framework using Scala. You can find more information about the Play Framework at https://www.playframework.com It uses the following core technologies:

• Postgres 9.5 with PostGIS 2.2.1
• Play Framework 2.5.0 with Scala 2.11.7

Deploying MapRoulette

Server

Local for test and development

Mac OSX

• These instructions assume you have at least Mac OS 10.10 (Mavericks) and Homebrew installed. We also assume that you have PostgreSQL 9.5 and PostGIS 2.2.1 installed. Homebrew provides packages for both, which we recommend.
• Make sure you have a Java 8 JDK. Check with java -version which should mention an 1.8.x version number. Get and install a Java 8 JDK if necessary.
• Install the Play Framework activator: brew install typesafe-activator.
• Create a PostgreSQL superuser osm: createuser -sW osm. Use osm as the password.
• Create a new PostgreSQL database mp_dev owned by osm: createdb -O osm mp_dev.
• Set the database connection JDBC string as environment variable DATABASE_URL: export DATABASE_URL='jdbc:postgresql://localhost:5432/mp_dev?user=osm&password=osm'
• Set the consumer_key and consumer_secret variables CONSUMER_KEY: export CONSUMER_KEY=<APPLICATION_CONSUMER_KEY>, CONSUMER_SECRET: export CONSUMER_SECRET=<APPLICATION_CONSUMER_SECRET>. This is the key and secret that is generated when you build your application in maproulette.org.
• Clone New MapRoulette: git clone https://github.com/maproulette/maproulette2.git.
• Navigate into the newly created maproulette2 directory and run the local development server: activator run. This will take some time the first run as dependencies are downloaded.
• Head to http://localhost:9000/ and confirm you can see the New MapRoulette front end. This also may take a while as artifacts are compiled.

Linux

• These instructions were written for Ubuntu 16.04
• Make sure you have a Java 8 JDK. Check with java -version which should mention a 1.8.x version number.
• If you don't have Java 8 JDK you can get it with the following command sudo apt install openjdk-8-jdk
• Install the Play Framework activator
  • After downloading unzip the archive to a directory that you have read and write access to
  • Then add activator to your path: Add the following to your .bashrc or equivalent: export PATH=$PATH:/path/to/unzipped-files/bin/
• Install PostgreSQL and PostGIS: sudo apt install postgresql postgis
• Create a PostgreSQL superuser: osm: sudo -u postgres createuser -sP osm. Use osm as the password
• Create a new PostgreSQL database mp_dev owned by osm: sudo -u postgres createdb -O osm mp_dev
• Set the database connection JDBC string as an environment variable: DATABASE_URL='jdbc:postgresql://localhost:5432/mp_dev?user=osm&password=osm'
• Set the consumer_key and consumer_secret variables CONSUMER_KEY: export CONSUMER_KEY=<APPLICATION_CONSUMER_KEY>, CONSUMER_SECRET: export CONSUMER_SECRET=<APPLICATION_CONSUMER_SECRET>. This is the key and secret that is generated when you build your application in maproulette.org.
• Clone New MapRoulette: git clone https://github.com/maproulette/maproulette2.git.
• Navigate into the newly created maproulette2 directory and run the local development server: activator run. This will take some time the first run as dependencies are downloaded.
• Head to http://localhost:9000/ and confirm you can see the New MapRoulette front end. This also may take a while as artifacts are compiled.

Using dev.conf

Another way to handle dev related configuration variables is to use the dev.conf file which has a couple of prepopulated variables that would be beneficial for a test/development environment. To use this file you simply need to add the file as a jvm parameter, eg. -Dconfig.resource=dev.conf

Creating new Challenges

Coming Soon...

In the mean time see here for current API documentation (not guaranteed to be stable yet).

Contact

Bug and feature requests are best left as an issue right here on Github. For other things, contact [email protected]

MapRoulette now also has a channel #maproulette on the OSM US Slack community. Invite yourself here!