diff --git a/README.md b/README.md index 84c91e647f4e361ef6e2ddcf629791f254745d85..68efa4bb97c7ed8b42ccb325f98671720aff33f3 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,15 @@ Il emploie l'API Web définie par [leximpact-socio-fiscal-api](https://git.lexim 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: +Il utilise la bibliothèque [xxhash-addon](https://www.npmjs.com/package/xxhash-addon), écrite en C. Pour pouvoir installer et compiler cette bibliothèque, il est nécessaire d'installer au préalable la [chaîne de compilation Node.js](https://github.com/ktrongnhan/xxhash-addon#installation), qui dépend de votre système d'exploitation. + +Pour fonctionner, ce simulateur socio-fiscal utilise un export des paramètres et variables d'OpenFisca. Pour le récupérer, exécuter la commande suivante dans un terminal: ```shell git clone https://git.leximpact.dev/openfisca/openfisca-france-json ``` -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 : +Une fois ces différentes opérations effectuées, exécuter les commandes ci-dessous pour vous déplacer dans le répertoire du projet et installer les librairies nécessaires : ```shell git clone https://git.leximpact.dev/leximpact/leximpact-socio-fiscal-ui diff --git a/package-lock.json b/package-lock.json index 0a56cf0d14db0515e4409f96db73d5ff16485d91..adf67baeb2bbdad8f4f13bc81021dcea96954324 100644 --- a/package-lock.json +++ b/package-lock.json @@ -8,7 +8,8 @@ "version": "0.0.1", "dependencies": { "node-fetch": "^2.6.1", - "sk-auth": "^0.3.7" + "sk-auth": "^0.3.7", + "xxhash-addon": "^1.4.0" }, "devDependencies": { "@auditors/core": "^0.1.7", @@ -48,8 +49,7 @@ "tailwindcss": "^2.0.3", "tslib": "^2.0.0", "typescript": "^4.0.0", - "uuid": "^8.3.2", - "xxhash-addon": "^1.4.0" + "uuid": "^8.3.2" } }, "node_modules/@auditors/core": { @@ -6928,7 +6928,6 @@ "version": "1.4.0", "resolved": "https://registry.npmjs.org/xxhash-addon/-/xxhash-addon-1.4.0.tgz", "integrity": "sha512-n3Ml0Vgvy7jMYJBlQIoFLjYxXNZQ5CbzW8E2Ynq2QCUpWMqCouooW7j02+7Oud5FijBuSrjQNuN/fCiz1SHN+w==", - "dev": true, "hasInstallScript": true, "engines": { "node": ">=8.6.0 <9.0.0 || >=10.0.0" @@ -11950,8 +11949,7 @@ "xxhash-addon": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/xxhash-addon/-/xxhash-addon-1.4.0.tgz", - "integrity": "sha512-n3Ml0Vgvy7jMYJBlQIoFLjYxXNZQ5CbzW8E2Ynq2QCUpWMqCouooW7j02+7Oud5FijBuSrjQNuN/fCiz1SHN+w==", - "dev": true + "integrity": "sha512-n3Ml0Vgvy7jMYJBlQIoFLjYxXNZQ5CbzW8E2Ynq2QCUpWMqCouooW7j02+7Oud5FijBuSrjQNuN/fCiz1SHN+w==" }, "yallist": { "version": "4.0.0", diff --git a/package.json b/package.json index a83b823bdef75f5cb8dd85bb1cc83c60b84ad309..697c8bc186461bd139a82f74146fe90a4ef36ebf 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,8 @@ }, "dependencies": { "node-fetch": "^2.6.1", - "sk-auth": "^0.3.7" + "sk-auth": "^0.3.7", + "xxhash-addon": "^1.4.0" }, "devDependencies": { "@auditors/core": "^0.1.7", @@ -52,8 +53,7 @@ "tailwindcss": "^2.0.3", "tslib": "^2.0.0", "typescript": "^4.0.0", - "uuid": "^8.3.2", - "xxhash-addon": "^1.4.0" + "uuid": "^8.3.2" }, "type": "module" }