https://github.com/SEL-Columbia/formhub

Mobile Data Collection made easy.
https://github.com/SEL-Columbia/formhub

Last synced: 7 days ago
JSON representation

Mobile Data Collection made easy.

• Host: GitHub
• URL: https://github.com/SEL-Columbia/formhub
• Owner: SEL-Columbia
• License: bsd-2-clause
• Created: 2011-10-04T15:23:04.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2015-07-30T13:40:39.000Z (over 9 years ago)
• Last Synced: 2024-08-02T05:17:38.457Z (3 months ago)
• Language: JavaScript
• Homepage: http://formhub.org
• Size: 33 MB
• Stars: 259
• Watchers: 49
• Forks: 163
• Open Issues: 114
• Metadata Files:
  • Readme: README.rst
  • Changelog: changelog.txt
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - SEL-Columbia/formhub - Mobile Data Collection made easy. (others)

README

        
Formhub

=======

.. image:: https://api.travis-ci.org/SEL-Columbia/formhub.png?branch=master

  :target: https://travis-ci.org/SEL-Columbia/formhub

Getting Started

---------------

* To build and install from source, follow the `Installation Guide `_

* Alternatively, you can just use these pre-built server images instead:

  * The public Formhub Amazon Machine Image (AMI) to `Run Your Own Formhub Instances on Amazon Web Services (AWS) `_

  * The public Formhub Virtual Disk Image (VDI) to `Run Your Own Formhub Instances on VirtualBox `_

Contributing

------------

If you would like to contribute code please read

`Contributing Code to Formhub `_.

Code Structure

--------------

Formhub is written in `Python `_, using the `Django Web Framework `_. 

In Django terms, an "app" is a bundle of Django code, including models and views, that lives together in a single Python package and represents a full Django application.

Formhub consists of three Django apps:

* odk_logger - This app serves XForms to ODK Collect and receives

  submissions from ODK Collect. This is a stand alone application.

* odk_viewer - This app provides a

  csv and xls export of the data stored in odk_logger. This app uses a

  data dictionary as produced by pyxform. It also provides a map and

  single survey view.

* main - This app is the glue that brings odk_logger and odk_viewer

  together.

Internationalization and Localization

-------------------------------------

Formhub can be presented in specific languages and formats, customized for specific audiences.

These examples were derived from `Django's Internationalization and Localization Documentation `_ and there is also a good explanation in `The Django Book's Chapter on Internationalization `_.

To generate a locale from scratch, e.g. Spanish:

.. code-block:: sh

    $ django-admin.py makemessages -l es -e py,html,email,txt ;

    $ for app in {main,odk_viewer} ; do cd ${app} && django-admin.py makemessages -d djangojs -l es && cd - ; done

To update PO files

.. code-block:: sh

    $ django-admin.py makemessages -a ;

    $ for app in {main,odk_viewer} ; do cd ${app} && django-admin.py makemessages -d djangojs -a && cd - ; done

To compile MO files and update live translations

.. code-block:: sh

    $ django-admin.py compilemessages ;

    $ for app in {main,odk_viewer} ; do cd ${app} && django-admin.py compilemessages && cd - ; done