Welcome to 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.
Please fork the project and submit pull requests on the develop branch.
First we need to set up system level dependencies. This is different for Linux and OSX.
On a fresh Ubuntu 12.04 LTS (also successfully tested on 13.04 and 13.10):
sudo apt-get install software-properties-common python-software-properties postgresql-server-dev-9.1 python-dev git virtualenvwrapper
Also make sure you have Postgis 2.0+. Ubuntu does not offer Postgis 2.0+ yet as part of their packages, see here for guidance.
If you want to install the latest PostgreSQL and PostGIS from packages for a non-LTS version of Ubuntu, this may help.
See installation with Homebrew
Note that on Mac OSX you may need to add a symlink to the coffee executable:
ln -s ~/node_modules/coffee-script/bin/coffee /usr/local/bin/
Next we need to make sure we have our MapRoulette database instance set up. MapRoulette uses PostgreSQL through the http://www.sqlalchemy.org ORM and the https://geoalchemy-2.readthedocs.org/en/latest/ spatial ORM. Unfortunately, GeoAlchemy2 only supports PostgreSQL / PostGIS, so we need to rely on that.
As the postgres user:
createuser -s -P osm
Enter the password osm twice.
Now create the three databases for the production, test and dev environments:
createdb -O osm maproulette
createdb -O osm maproulette_test
createdb -O osm maproulette_dev
Now you can switch back to a non-postgres user.
Add PostGIS extensions to the databases:
psql -h localhost -U osm -d maproulette -c 'CREATE EXTENSION postgis'
psql -h localhost -U osm -d maproulette_test -c 'CREATE EXTENSION postgis'
psql -h localhost -U osm -d maproulette_dev -c 'CREATE EXTENSION postgis'
If you have not used virtualenvwrapper before, you should spawn a new shell at this point for the virtualenvwrapper scripts to be sourced.
Set up the virtual environment and activate it:
mkvirtualenv maproulette
Clone the repo:
git clone https://github.com/osmlab/maproulette.git
Install the python requirements:
cd maproulette/
pip install -r requirements.txt
Wait for things to be downloaded, compiled and moved into place. There will be warnings, but the process should end with a confirmation that a bunch of python modules were installed.
Ensure that maproulette will be accessible to python:
add2virtualenv .
Have a look at the configuration defaults at maproulette/config/__init__.py and adapt as needed. (If you followed the previous to the letter you should not need to change a thing.)
Generate the database tables:
python manage.py create_db
If you're developing, you may want to load some test challenges and tasks:
bin/load_fixtures.py
Finally, run the server:
python manage.py runserver
At this point you should see:
- Running on http://0.0.0.0:5000/
- Restarting with reloader
And you should have a MapRoulette instance at http://localhost:5000/
MapRoulette relies heavily on the lightweight Flask web application framework, and some of its extensions, notably Flask-OAuth, Flask-RESTful, Flask-Script, Flask-Runner and Flask-SQLAlchemy. For working with geospatial data, MapRoulette relies on GeoAlchemy2 and Shapely.
There is also API documentation.
Note that there is also an Amazon EC2 AMI that has all the requirements for MapRoulette already installed and configured. To use, just fire up an instance of ami-8985f0e0 and
cd maproulette
git pull
workon maproulette
python manage.py runserver