Skip to content
OpenMapKit Server is the lightweight server component of OpenMapKit that handles the collection and aggregation of OpenStreetMap and OpenDataKit data.
JavaScript Other
Branch: master
Clone or download
Latest commit 1becd37 Oct 30, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api
data commit archive dirs Apr 9, 2018
docs Merge branch 'master' into optional-auth Aug 1, 2018
frontend Merge branch 'master' into optional-auth Aug 1, 2018
scripts tar-osm.sh utility script Mar 16, 2016
test
util Merge pull request #118 from hotosm/master Aug 8, 2018
.dockerignore Dockerized Mar 30, 2017
.gitignore ignore build files and add the pushbuild command Aug 1, 2018
.gitmodules update submodule url Oct 30, 2019
.nvmrc Refactor upload process to catch conflicts Mar 30, 2017
Dockerfile Merge pull request #118 from hotosm/master Aug 8, 2018
LICENSE Create LICENSE Feb 18, 2016
README.md update docs Aug 1, 2018
build_frontend.js Merge branch 'master' into build_dist Aug 1, 2018
index.js
package.json 0.12.0 Aug 8, 2018
requirements.txt first attempt at installing pyxform Dec 13, 2015
server.js major path refactor, submodules messed up Feb 19, 2016
settings.js sync data dir to AWS S3 May 11, 2018
start_frontend.js add startdev command and modify start command to be used on production Mar 8, 2018
yarn.lock Merge branch 'master' into build_dist Aug 1, 2018

README.md

OpenMapKit Server

OpenMapKit Server is the lightweight NodeJS server component of OpenMapKit that handles the collection and aggregation of OpenStreetMap and OpenDataKit data.

This software is intended to run both on low-power embedded Linux systems, as well as on higher powered, cloud-based servers.

OpenMapKit Server is 100% database free! All data is persisted on the file system.

Development Installation

These instructions are for setting up and running OpenMapKit Server in your development environment.

Production Installation

If you want to run OpenMapKit Server for your field mapping survey, use the POSM Build Installation instructions and POSM documentation.

Project Structure

deployments is the OpenMapKit deployment API. This services deployment data in the deployments data directory. Manifest files in this directory are read by OpenMapKit Android as metadata regarding the deployment data provided. Deployments are created by posm-admin. to provision deployment data that is fetched by OpenMapKit Android.

odk is the OpenMapKit ODK API. This is a REST API that handles all of the ODK business logic, including communicating with ODK Collect, as well as serving and ingesting ODK XForm data.

frontend is where the front end code lives.

data is where all of the data is stored on the server's file system.

util has utility functions useful to OpenMapKit Server as a whole.

The Basics

After your installation is done, you can see if the server is alive at:

http://{{your_host_url}}/info

To get forms and send submissions in ODK Collect set:

ODK Collect > General Settings > Configure platform settings > URL

http://{{your_host_url}}

See all of the pages on your server:

http://{{your_host_url}}/pages/

Upload an XLS Form:

http://{{your_host_url}}/pages/upload-form/

API

Check out the API Documentation for details about the REST API.

ZenHub

Miscellany

Testing XML Submissions

curl -F xml_submission_file=@problematic.xml http://localhost:3210/submission
You can’t perform that action at this time.