Custom mapping presets and validation rules
MapRules is an api service that allows mappers and mapping campaign managers to define custom mapping presets and validation rules usable in OpenStreetMap Editors.
The goal of MapRules is to simplify OpenStreetMap feature tagging and validation.
...see the Architecture for a technical description of the repos work together
ubuntu!
sudo apt-get update
sudo apt-get install -yq sqlite3 libsqlite-dev
centos!
sudo yum update
sudo yum install -yq
mac!
brew install sqlite3
windows!
...use this for guidance!
# with nvm installed and from root of MapRules directory...
nvm install #only run first time if you don't have the right version
nvm use
...see here for setting up nvm on a linux machine ...see here for setting up nvm on a windows machine
yarn install -G sqlite3 && yarn install
A "development instance" of the OSM Site could be the openstreetmap-website that you clone and run on your machine, or (perhaps easier) you could be one of the development instances that OSM provides like https://master.apis.dev.openstreetmap.org
To actually get the tokens, once you have a login for your development instance, go to the /user/username/oauth_clients/new web page and fill out the form. When it comes to permissions, only select the read their user preferences checkbox. Use Consumer Token and Consumer Secret keys provided once you submit the form for the CONSUMER_KEY and CONSUMER_SECRET environmental variables. So too should you supply the development osm site you use as the OSM_SITE environmental variable.
...the iD editor's presets use very nice icons. the ICON lookup table tries to match the custom maprules presets with icons made for presets with matching tags
yarn build
NODE_ENV=development JWT=${some.jwt} yarn fixture
..note, the JWT value above needs to be used whenever running the app in the same NODE_ENV.
PORT=3001 yarn dev
yarn test // propended with all needed env variables...
test with docker image
docker build -f Dockerfile . && docker run MapRules /bin/bash -c 'npm run test:fixture // with needed environmental variables'
MapRules uses PM2 command line tool to manage the service when running in production. If PM2 is for you, its certainly a great option for local development.
The process.yml file acts as the configuration file for PM2, and since it holds all the kinds of secret keys, you never want to commit this to a remote branch/make it exposed outside the machine you use to run maprules.
As such, and this might be overkill that can be changed in the future, the process.yml is built from a process.yml.in, which we keep gitignored.
So, create a process.yml.in file and place a configuration like the one below in it, using the client keys, osm site, and secret session/jwt keys for maprules. Note, we also give a fully hydrated example for the classic development, staging, production environment set used for software in a process.yml.example file.
apps:
- name: maprules
script: index.js
env_production
NODE_ENV: production
PORT: ${YOUR.FAVORITE.PORT}
HOST: ${YOUR.FAVORITE.HOST}
CONSUMER_KEY: ${CONSUMER.KEY.FROM.OSM.SITE},
CONSUMER_SECRET: ${CONSUMER.SECRET.FROM.OSM.SITE},
OSM_SITE: ${URL.TO.OSM}
YAR: ${PRIVATE.KEY.FOR.YAR},
JWT: ${PRIVATE.KEY.FOR.JWT}With everything in your process.yml.in file, run the build script again and you'll be ready to use PM2 as you need. The prod npm command is an example of how to get maprules running with pm2 for a configuration that matches the yml snippet above.