L'interface utilisateur (et le serveur principal) de mes-aides, un estimateur des prestations sociales françaises pour les particuliers. Il est basé sur simulateur socio-fiscal libre Openfisca.
If you want to play with the UI, you can be set up very quickly:
npm run fast-install
npm run frontCf. package.json for more on the underlying commands.
The application should be accessible at localhost:8080.
Make sure build-essential, mongodb and node 8.x are installed on your machine:
sudo apt-get install build-essential
sudo apt-get install mongodbThe runtime is Node 8.x for the web application, and Python 3 for Openfisca.
You can for example use nvm to install this specific version.
You will need pip to install Openfisca.
git clone https://github.com/sgmap/mes-aides-ui.git
cd mes-aides-ui
npm installYou should install Python 3 in a virtualenv to prevent yourself from messing with your main python installation. You can either create the virtualenv yourself or rely on tools such as virtualenvwrapper or pew:
cd mes-aides-ui
virtualenv --python=python3 .venv # To create your virtualenv in ./.venv (a hidden folder)
source .venv/bin/activate # To activate your virtualenv
pip install pip --upgrade # To make sure you're using pip latest versionnpm run install-openfisca
npm run openfiscaEach time you want to run OpenFisca, you have to source .venv/bin/activate to get a working OpenFisca environment.
If you are working on openfisca-france and want to use your local version:
cd (...)/openfisca-france
pip install -e .
First, start a Mongo server:
npm run dbThen, in another shell (you will have to run source .venv/bin/activate), start the Openfisca server:
npm run openfiscaFinally, in a third shell, start the server:
npm run serveThere are several levels of tests:
- Unit tests run with
npm test. - Integration tests run with
npm run test-integration. - Business tests from Ludwig.
You can safely use npm test && npm run test-integration to drive your developments.
Integration tests are executed with Watai through npm run test-integration. These tests are currently not run in CI due to how complex installing all dependencies on a CI VM is.
Most integration tests do not require any business to pass. However business test integration is tested by ludwig-suite. Therefore that suite currently fails if business tests were not imported from npm run db-update as described in the next section.
Note: ludwig-suite can be excluded. In test/integration/run-integration-tests.sh you can replace $TEST_DIR/*-suite with $TEST_DIR/[^l]*-suite.
Business tests are executed in a more convoluted way.
We use Ludwig to help users create business tests. These tests have to be fetched and loaded in your local database so you can execute them on your development machine.
To do so, run npm run db-update script at the root of the repository. You will need a running Mongo database (npm run db) and SSH access to the production server.
En plus de l'intégration continue, ce dépôt est configuré pour avoir du déploiement continu. À l'ajout de commits sur mes-aides/simulateur#master les tests sont relancés puis la production mise à jour.
Éditer le fichier openfisca/requirements.txt en y indiquant la version d'Openfisca que vous souhaitez utiliser.
Ce fichier est au format requirements.txt de pip. Généralement, vous le mettrez à jour pour faire pointer l'un des modules Openfisca vers une branche de développement en attendant la publication de ce module sur PyPI.
Le serveur de production est rendu opérationnel avec Puppet. Les fichiers de configurations et de paramétrage sur disponibles dans un dépôt séparé.
Des clés SSHs ont été générées pour lancer des scripts à distance sur le serveur de production.
Sachant que le fichier deploy contient la clé privée associée au script de déploiement, ce dernier permet être lancé via la commande suivante :
ssh [email protected] -i deployPour effectuer des modifications plus exotiques, il est nécessaire de se connecter en tant que root.