ODK Build is a web-based, drag-and-drop service for creating forms used with data collection tools such as ODK Collect. ODK Build is part of Open Data Kit (ODK), a free and open-source set of tools which help organizations author, field, and manage mobile data collection solutions. Learn more about the Open Data Kit project and its history here and read about example ODK deployments here.
config.ru Rackup file. We use
shotgun for local development and Phusion Passenger for staging and production deployment.
All Rubygem dependencies are managed by Ruby Bundler. There are config files present for
bundle install in the application root to resolve and install the appropriate dependencies. You can do
--without test to skip some gems if you're short on bandwidth.
We depend on one native binding, to connect to a PostgreSQL database. To satisfy the binding, you can install
libpq-dev on apt, or
postgresql on homebrew.
If you run into trouble, see the building guide for further details.
Setup and Execution
Now that you have resolved all the appropriate dependencies, you'll need to set up the configuration by copying
config.yml. This file contains a number of secret keys and tokens, so be sure not to check it into source control once you put your own keys into it. Note that the
cookie_ssl_only flag should only be set to true if you are serving your requests on HTTPS; it should likely remain off for local development.
Next, you want to start up your databases. Create a database in your Postgres instance according to how you populated
config.yml, then run
rake db:migrate to run migrations against that database. Ideally, create the database with an encoding of
Finally, you'll want to run
bundle exec rackup config.ru to start the server, or
bundle exec shotgun config.ru if you want the application to automatically detect your changes to source code and load them up when you refresh the app in your web browser.
If you're running Build in a production environment, there are a couple of things that the application needs to build before it will run. Before first-run, and after each time you update with a new version, you'll want to run
rake deploy:build. This will bundle all the assets the application needs for speed an ease of deployment.
There is a separate native-desktop build of ODK Build that is actively maintained; versions of it may be downloaded under the releases page, and the code for it is found under the
offline branch of this repository. It uses NWjs (formerly
A full README for developers wanting to work on this version is available in the root of the
Pull requests are welcome! Please be sure you follow existing conventions: braces on newlines, 4-width soft tabs, single-quoted strings, and so on. Don't be shy about submitting living pull requests early, so we can all work together to refine your contribution. See the full contribution guide for further details.
Build is licensed under the Apache 2.0 license.