README.md v1.3, 9 April 2014 [ogl, adriancollier]

Akvo Really Simple Reporting (Akvo RSR)

Akvo Foundation is a non-profit foundation that builds open source internet and mobile phone software which is used to make international development cooperation and governance more effective and transparent.

Akvo RSR is part of the Akvo platform. Akvo RSR is a web and Android-based system that makes it easy for international development teams to bring complex networks of projects online and instantly share progress with everyone involved and interested.

We believe that Akvo RSR can be used in many other scenarios, including environmental programs and monitoring.

Development

For local development Vagrant is used. The development env is loaded with a small fixture data set with available accounts. To get from checkout to running server use these steps:

Setup local settings

$ cp akvo/settings//66_local.template akvo/settings/66_local.conf

Boot vagrant environment

This will download a vagrant box, provision the box with Puppet, download initial data and load that data. Hence this steps takes a while,

$ cd vagrant && vagrant up --provider=virtualbox
...
$ cd ..

Now open a browser and visist http://rsr.localdev.akvo.org/. We're now using the production Gunicorn webserver. For development the Django development server which gives you code reloading is really handy.

Run a local devserver

To run the Django devserver with code reloading and getting prints

$ cd scripts/devhelpers
$ ./supervisord.sh stop rsr && ./manage.sh runserver

Make sure assets are rebuilt on change (WIP)

To build assets we're relying on node.js and gulp. So with node and gulp available: