Skip to content
OpenMapKit Server is the lightweight server component of OpenMapKit that handles the collection and aggregation of OpenStreetMap and OpenDataKit data.
JavaScript CSS Other
Branch: master
Clone or download
Pull request Compare This branch is 140 commits ahead, 6 commits behind posm:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api discover image field on the submission json file + fix bug on data en… May 2, 2019
cloudformation add ENABLE_HTTPS env var, update cfn template, docs and lib version Apr 16, 2019
data commit archive dirs Apr 9, 2018
docs add ENABLE_HTTPS env var, update cfn template, docs and lib version Apr 16, 2019
frontend discover image field on the submission json file + fix bug on data en… May 2, 2019
scripts tar-osm.sh utility script Mar 16, 2016
test Closes #64 Apr 28, 2016
util Cloudformation template for this stack (#91) Mar 11, 2019
.dockerignore Dockerized Mar 30, 2017
.ebignore Update ignore files for EB Deploy Aug 15, 2018
.gitignore Update ignore files for EB Deploy Aug 15, 2018
.gitmodules Removed submodule id May 27, 2016
.nvmrc update .nvmrc file Feb 14, 2019
Dockerfile update node version to 8 Feb 8, 2019
LICENSE Create LICENSE Feb 18, 2016
README.md add documentation about users Oct 12, 2018
alarms.md Alarms investigation (#111) Mar 11, 2019
build_frontend.js Merge branch 'master' into build_dist Aug 1, 2018
index.js add authentication to /odk/data/submissions/ Oct 12, 2018
package.json update version to 1.5.1 May 2, 2019
requirements.txt change util/get_data_files.js and requirements Nov 12, 2018
server.js major path refactor, submodules messed up Feb 19, 2016
settings.js unset osmApi and only call createAndSubmitChangesets when osmApi is c… Mar 12, 2019
start_frontend.js add startdev command and modify start command to be used on production Mar 8, 2018
yarn.lock Merge branch 'master' into map-table-updated Apr 23, 2019

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}}/omk/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}}/

Upload an XLS Form:

http://{{your_host_url}}/omk/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.