OpenFisca Web User Interface

Web user interface for OpenFisca -- a versatile microsimulation free software

Documentation

Please consult the OpenFisca documentation

Installation

Prerequisites:

• git
• GNU Make
• Node.js
• MongoDB
• npm
• pip
• Python

The way to install these tools depends on your operating system (not documented here).

From the cloned repository directory:

pip install --user --editable .
python setup.py compile_catalog
python openfisca_web_ui/scripts/setup_app.py development-france.ini
npm install
make build-dev

OpenFisca-Web-UI is a client of the OpenFisca-Web-API (called with AJAX requests).

You can either use the official API instance (http://api.openfisca.fr) or install an instance on your machine if you need to work on the code of either the API, the Core or the tax-benefit system (OpenFisca-France for example). In this case please read the installation documentation.

Run the server

First run the MongoDB server.

Configure the web API URLs in development-france.ini:

• to use your own instance of the web API, leave the default values
• to use the public instance of the web API, change the URLs containing localhost:2000 by api.openfisca.fr

Then run the web server of the UI from its directory (open another terminal tab):

paster serve --reload development-france.ini

Open the URL http://localhost:2020/ in your browser.

Development

If you change the Python source code, the web server will reload and you'll have to reload the page in your browser.

Use the "watcher" to rebuild the code when a JavaScript file changes:

make watch