Ceci est le code source de l'application [simulateur-socio-fiscal.leximpact.dev](https://simulateur-socio-fiscal.leximpact.dev).
Il comprend une représentation graphique des effets de la loi sociale et fiscale sur des situations de personnes.
## Installation
## Présentation
Ce dépôt requiert [NodeJS](https://nodejs.org/fr/) version 12 ou supérieure.
Il est construit sur la base du framework [Svelte](https://svelte.dev/)(et[Tailwind](https://tailwindcss.com/)).
Ce projet est construit sur la base du framework JavaScript [SvelteKit](https://kit.svelte.dev/)(et[TailwindCSS](https://tailwindcss.com/)).
Il emploie l'API Web définie par [leximpact-socio-fiscal-api](https://git.leximpact.dev/leximpact/leximpact-socio-fiscal-api) pour faire appel au moteur de microsimulation socio-fiscale [OpenFisca-France](https://github.com/openfisca/openfisca-france) et calculer les effets de la loi.
Afin de l'installer, ouvrir un terminal et exécuter les commandes suivantes pour vous déplacer dans le répertoire du projet et installer les librairies nécessaires :
## Installation
Ce projet fonctionne avec [NodeJS](https://nodejs.org/fr/) version 16 ou supérieure.
Il nécessite un export JSON des paramètres et variables d'OpenFisca. Pour le récupérer, exécuter la commande suivante dans un terminal:
Une fois cela fait, exécuter les commandes ci-dessous pour vous déplacer dans le répertoire du projet et installer les librairies nécessaires :
```shell
cd leximpact-socio-fiscal-ui/
...
...
@@ -21,14 +30,20 @@ L'installation indique les librairies installées et s'achève sans erreur.
## Exécuter l'application - mode développeur
Dans le répertoire de l'application `leximpact-socio-fiscal-ui/`, exécuter la commande :
Dans le répertoire de l'application `leximpact-socio-fiscal-ui/`, créer un fichier `.env`, par exemple en faisant un lien vers `example.env` (ou en l'adaptant à vos besoins) :
```shell
ln-s example.env .env
```
Puis, exécuter la commande :
```shell
npm run dev
```
La commande n'affiche pas d'erreur et conserve la main tout en restant à l'écoute des modifications de code.
La commande conserve la main tout en restant à l'écoute des modifications de code.
L'application peut alors être consultée dans un navigateur à l'adresse indiquée (par défaut : `http://localhost:3000`)
L'application peut alors être consultée dans un navigateur à l'adresse indiquée (par défaut : `http://localhost:3000`), mais la première fois il peut être nécessaire de la recharger plusieurs fois, le temps que toutes les dépendances se compilent.
Bravo ! Vous êtes prêt·e·s à utiliser et contribuer à `leximpact-socio-fiscal-ui` 🎉
Bravo ! Vous êtes prêts à utiliser et contribuer à `leximpact-socio-fiscal-ui` 🎉