Web user interface for OpenFisca -- a versatile microsimulation free software
Please consult the OpenFisca documentation
Prerequisites:
The way to install these tools depends on your operating system (not documented here). Some software might be installed by default, please check.
cd
mkdir openfisca
cd openfisca
git clone https://github.com/openfisca/openfisca-web-ui.git
cd openfisca-web-ui
python setup.py compile_catalog
pip install --user --editable .
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.
Depending on your OS you might start the MongoDB server by hand.
If you intend to use your own instance of the web API, run the web server of the API (here we assume you installed it previously):
cd ~/openfisca/openfisca-web-api
paster serve --reload development-france.ini
Otherwise you can change the api.baseUrl config key to http://api.openfisca.fr in the config file
(for example development-france.ini).
Then run the web server of the UI (in another terminal tab since the previous one is blocked by the previous web server):
cd ~/openfisca/openfisca-web-ui
paster serve --reload development-france.ini
Open the URL http://localhost:2015/ in your browser.
If you change the Python source code, the web server will reload and you'll have to reload the page in your browser.
If you'd like to change the JavaScript source code, it is recommended to use the "watcher" to rebuild the code automatically:
make watch