@incubateur-ademe/publicodes-commun
v1.1.5
Published
<div align="center"> <h3 align="center"> <big>Publicodes règles communes</big> </h3> <p align="center"> <a href="https://github.com/incubateur-ademe/publicodes-commun/issues">Report Bug</a> • <a href="https://incubateur-ademe.github.io/pub
Downloads
148
Keywords
Readme
Ensemble de règles communes utilisées pour l'implémentation des modèles publicodes de l'incubateur de l'ADEME.
Sa documentation est disponible en ligne.
Usage
Ajouter le paquet à vos dépendances :
yarn add @incubateur-ademe/publicodes-commun
Instancier un nouveau moteur Publicode :
import Engine from 'publicodes'
import rules from '@incubateur-ademe/publicodes-commun'
const engine = new Engine(rules)
engine.evaluate('intensité électricité')
Utiliser certaines règles dans un autre modèle publicodes :
importer!:
depuis:
nom: @incubateur-ademe/publicodes-commun
url: https://github.com/incubateur-ademe/publicodes-commun
dans: règles communes
les règles:
- intensité électricité
En local
Compiler le modèle
Les règles publicodes du modèle sont disponible dans le workspace
rules/
.
Pour installer les dépendances et compiler tous les fichiers .publicodes
en
un seul fichier JSON, il suffit d'exécuter la commande suivante :
yarn && yarn run build
Lancer la documentation
Le code de la documentation est disponible dans le workspace
doc/
.
Pour lancer l'app React en local permettant de parcourir la documentation du modèle, il suffit d'exécuter la commande suivante :
yarn i --cwd doc
yarn run doc
Lancer l'API
Le code de l'API est disponible dans le workspace
api/
.
Pour lancer le serveur Node permettant d'utiliser l'API REST, il faut utiliser les commandes suivantes :
yarn run api
# En watch-mode
yarn run api:watch
Publier une nouvelle version
Afin de publier une nouvelle version il suffit d'exécuter la commande npm
version
.