Setting up a local environment to build and test CHT applications
Prerequisites for App Development
There are no set prerequisites for users of CHT apps, yet the following are helpful for developing CHT applications.
To build your own application using the Core Framework you will need an instance set up for testing. You can set up a local instance by following these instructions.
The build tool for applications using the Core Framework is
cht-conf. To set it up, follow the installation instructions. To properly use the tool you will need your application files in set locations within a folder. Once you are set up with the basic file structure you can edit the files, and rebuild the application by compiling or converting components as needed, and uploading them to your test instance.
To build applications with the Core Framework the follow skills are helpful, ordered by importance:
XLSForms and XForms
Many workflows in your application, including completing tasks and creating contacts, will be generated using ODK XForms. Many app developers use XLSForms as an easier way to generate XForms. A strong knowledge of XLSForm standard is very useful in building your own application.
A free and open source NoSQL database we use to store all our data, configuration, and even the application code. CouchDB is really good at replication which is the process of sending the data to another database, such as PouchDB in the client application, and back again. Although building your own app using the Core Framework does not require knowledge or experience with CouchDB it can be useful to be familiar with general concepts as a document store.
Although the application you build uses a NoSQL database, a parallel PostgreSQL database is available in the Core Framework to make querying data easier. Familiarity with SQL is needed to set up and query the database.
Download and run the publicly available Docker image for CHT applications
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.