Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 2.23 KB

README.md

File metadata and controls

29 lines (22 loc) · 2.23 KB

Simple ODK

travis npm downloads js-standard-style donate

Currently experimental, things will change and potentially break

This is a minimal server for OpenDataKit (ODK) that uses Github for storing form submissions as geojson files, and media files on Amazon S3. It can receive form submissions from ODK Collect. Authentication is passed through to Github - you will need to enter your github username and password in ODK Collect.

The Github repo for form storage is defined by the url used in ODK Collect: http://simpleodk.org/:user/:repo/ where :user is your github username and :repo is the github repo where you would like to store the form submissions. The Github user authenticaed with ODK Collect must have write access to this repo.

The Amazon S3 bucket used for storage is also derived from the url, of the form simpleodk.user.repo. You will need to provide S3_KEY and S3_SECRET via environment variables for a user that has S3:PutObject and S3:PutObjectAcl permissions on the bucket. If you do not submit any photos / media files with the forms, you do not need an S3 bucket.

This is like Jekyll - using static files for data. It avoids needing to maintain a database and it means we always have access to the raw data, even if servers go down (unless github goes down, of course, but then the whole web is in trouble).