Enketo - ODK Backend

About 📖

Enketo has been used all around the world for a wide range of uses from needs assessments in humanitarian aid, to raising historical awareness, to clinical research, to election monitoring.

Features 🎯

• Can connect to your custom backend
• Have the edit api in case user wants to edit submitted response
• Api for the customize change in XML of form
• Have beautiful themes and widgets
• Are printer-friendly
• Can use very powerful skip and validation logic
• Run on any device, mobile or desktop, as long as it has a fairly modern browser

Use Case 🚀

Requirements 📜

1. Your machine should have Yarn or Npm, Docker, Python installed.

Note: Preferable Npm version (6.14.15) and Node version(v14.18.1) and Ubuntu OS version(18.04)*

2. Check the node and npm version by running following commands.

node -v
npm -v

Installation Steps 🚶

1. Fork it 🍴

You can get your own fork/copy of enketo by using the Fork button.

2. Clone it 👥

You need to clone (download) it to a local machine using

git clone https://github.com/Your_Username/enketo.git

This makes a local copy of the repository in your machine.

Once you have cloned the enketo repository in GitHub, move to that folder first using the change directory command.

# This will change directory to a folder FOSSologyUI
cd enketo

Move to this folder for all other commands.

3. Set it up ⬆️

Run the following commands to see that your local copy has a reference to your forked remote repository in GitHub

git remote -v
origin  https://github.com/Your_Username/enketo.git (fetch)
origin  https://github.com/Your_Username/enketo.git (push)

4. Run it 🏁

cd enketo-express
docker run --name enketo-redis-main -p 6379:6379 -d redis
docker run --name enketo-redis-cache -p 6380:6379 -d redis
npm install
npm i -g grunt
grunt develop

cd ../enketo-core
npm install
npm start

cd ../enketo-transformer
npm install
npm start

cd ../forms
python3 -m http.server

You can preview your form on http://localhost:8005/preview?xform=http://localhost:8000/sample.xml

5. For integrating your backend

Customize the submission url with your hosted backend.

Future Enhancements 🚀

• Encrypting query parameters on rendering the enketo form.
• Writing a API for changing an XML form directly from it.