Skip to content
Snippets Groups Projects
Commit eeeee1ec authored by sandcha's avatar sandcha
Browse files

Document that the application is in TS and explicit execution modes

parent 925e1ce9
Branches
No related tags found
1 merge request!5Désactive le PLF 2022
# Interface LexImpact budget
Ceci est le code source de l'[interface Web]((https://budget.leximpact.an.fr/budget)) de l'application LexImpact dédiée au calcul budgétaire de différents dispositifs (CSG, CRDS).
Ceci est le code source de l'[interface Web](<(https://budget.leximpact.an.fr/budget)>) de l'application LexImpact dédiée au calcul budgétaire de différents dispositifs (CSG, CRDS).
Il comprend une représentation graphique des effets de la loi sur la population et le budget.
## Présentation
Ce projet est construit sur la base du framework JavaScript [SvelteKit](https://kit.svelte.dev/) (et [TailwindCSS](https://tailwindcss.com/)).
Ce projet est construit sur la base du framework JavaScript [SvelteKit](https://kit.svelte.dev/), en [TypeScript](https://www.typescriptlang.org) et avec [TailwindCSS](https://tailwindcss.com/).
Il emploie l'API Web définie par [leximpact-budget-api](https://git.leximpact.dev/leximpact/leximpact-budget-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.
## Configuration
## Configurer
Dans le répertoire de l'application `leximpact-budget-ui/`, créer un fichier `.env` en se basant sur l'exemple fourni :
......@@ -17,9 +17,9 @@ Dans le répertoire de l'application `leximpact-budget-ui/`, créer un fichier `
cp example.env .env
```
Et adapter son contenu aux besoins du développement, de l'intégration ou de la production selon les commentaires indiqués dans le `example.env`.
Et adapter son contenu aux besoins du développement, de l'intégration ou de la production selon les commentaires indiqués dans l'`example.env`.
## Installation
## Installer
### NodeJS
......@@ -47,7 +47,14 @@ npm install
> L'environnement peut également être réinitialisé avec la commande `npm run clean`.
## Exécuter l'application - mode développeur
## Exécuter l'application
Deux modes d'exécution cohabitent et dépendent du cas d'usage que l'on a :
- le mode développeur permet de voir le produit du code ainsi que l'effet direct des modifications qui y sont apportées,
- ou le mode production qui permet de générer un build pour une mise en ligne sur serveur de production (ou une évaluation en local).
### Mode développeur
Dans un terminal, exécuter la commande :
......@@ -63,7 +70,7 @@ L'application peut alors être consultée dans un navigateur à l'adresse indiqu
Bravo, vous êtes prêts à utiliser et contribuer à `leximpact-budget-ui` ! 🎉
## Exécuter l'application - mise en production
### Mise en production
Dans un terminal, exécuter la commande :
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment