Now Deprecated. Please use https://github.com/dimagi/formplayer

A django-based web XForms Player for touchscreens

Prerequisites

Python (2.6+ recommended) Django (1.2+ recommended) Java (1.5+ recommended) Jython (2.5+ required)

for building offline cloudcare: maven2 jinja2

Getting started

Get the prerequisites. Get the code.

Update your settings.py:

Add "touchforms.formplayer" to your INSTALLED_APPS
Add XFORMS_PLAYER_URL = "http://127.0.0.1:4444"

Syncdb:

python manage.py syncdb

Set localsettings.py for this backend::

add URL_ROOT = "http://your.commcarehq/a/{{DOMAIN}}"

Run the backend:

cd backend
jython xformserver.py 4444

Run the django frontend:

python manage.py runserver

Play forms!

Information passing

There are multiple calls that touchforms makes to CommCare HQ. Here is a summary of how they work.

Call	URL	Auth
Get XForm	get_url_base() / settings.BASE_ADDRESS	None required
Load case data	touchforms.localsettings.URL_ROOT	Session (cloudcare) or settings.TOUCHFORMS_API_USER (sms)
Load fixture data	touchforms.localsettings.URL_ROOT	Session (cloudcare) or settings.TOUCHFORMS_API_USER (sms)
Load ledger data	touchforms.localsettings.URL_ROOT	Session (cloudcare) or settings.TOUCHFORMS_API_USER (sms)

Running Tests

To run the backend tests you can just run the following

jython touchforms/backend/test_server.py && \
jython touchforms/backend/test_xformplayer.py && \
jython touchforms/backend/test_touchcare.py && \
jython touchforms/backend/test_global_state_manager.py

To run tests you need to have Jython and PhantomJS installed. On linux PhantomJS needss to be installed from source. Then run the following commands

pip install -r touchforms/test_requirements.txt
./run_tests.sh

Running Frontend tests

The JS tests are run with ./run_tests.sh script, but if you'd like to run the tests in the browser you can do that as well. You will need to have jasmine installed:

pip install -r touchforms/test_requirements.txt

Then to start the Jasmine server run this command in the terminal:

cd touchforms jasmine

This will start a server on http://localhost:8888. Navigate to that URL and the tests will run in the browser!