@betagouv/france-chaleur-urbaine-publicodes

Publicodes x France Chaleur Urbaine

Report Bug • API docs • Contribute • Publicodes

Modèle Publicodes du comparateur réalisé en partenariat avec l'association AMORCE dans le cadre de l'action C3 du programme européen Heat & Cool

Usage

Ajouter le paquet à vos dépendances :

yarn add @betagouv/france-chaleur-urbaine-publicodes

Instancier un nouveau moteur Publicode :

import Engine from "publicodes"
import rules from "@betagouv/france-chaleur-urbaine-publicodes"

const engine = new Engine(rules)

engine.evaluate("dépenses primeur")

Utiliser certaines règles dans un autre modèle publicodes :

importer!:
  depuis:
    nom: @betagouv/france-chaleur-urbaine-publicodes
    url: https://github.com/betagouv/france-chaleur-urbaine-publicodes
  les règles:
    - prix . carottes
    - prix . carottes
    - prix . avocats

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 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 install --cwd doc

yarn 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 install --cwd api

yarn api

Publier une nouvelle version (manuellement pour le moment)

Afin de publier une nouvelle version il suffit d'exécuter la commande yarn publish.