Yelandur is the backend API server for Science en Poche, a project to make it easy to build research and citizen project apps on smartphones:

It works with Naja as a web UI to visualize and retrieve the data resulting from experiments.

It's written in Python, using the Flask framework and MongoDB.

Yelandur is tested on Python 2.7. Any other version might (and usually does) generate unexpected errors.

You'll need a working instance of MongoDB. On Debian/Ubuntu this is done by executing:

sudo apt-get install mongodb
sudo service mongodb start

If you're not already using virtualenv and virtualenvwrapper, start now. On Debian/Ubuntu this is done by executing:

sudo apt-get install virtualenvwrapper

and restarting your Bash session.

You will also need to install a few additional packages for the commands below to work. Do this by running:

sudo apt-get install python-pip

Next, after cloning the code, cd into the repository and run:

mkvirtualenv yelandur            # Creates a new clean virtual environment and activates it
pip install -r requirements.txt  # Installs all necessary dependencies in the virtualenv
python manage.py runserver       # Starts the server

The server starts listening on 0.0.0.0:5000 (i.e. all network addresses, port 5000), and behaves according to the API described in API.md (in the root of this repository; if you're viewing this on GitHub, scroll back up to find it).

Run nosetests from the root folder to run all the tests.

requirements_dev.txt includes all of requirements.txt plus some additional dependencies I use to have Vim behave nicely with Python and unittests. Not necessary to run the server, but handy to hack on the code.