Publicodes Package Template

Report Bug • API docs • Contribute • Publicodes

Template dépôt GitHub pour créer un paquet Publicodes.

Fonctionnalités

• 📦 compilation des règles publicodes en un seul fichier JSON grâce à @incubateur-ademe/publicodes-tools
• 📖 documentation du modèle interactive disponible sur GitHub Pages grâce à @publicodes/react-ui
• 🚀 API REST pour utiliser le modèle dans une application grâce à @publicodes/api

Initialisation

Pour utiliser ce template, il suffit de cliquer sur le bouton Use this template. Puis de remplacer les variables suivantes dans tous les fichiers du projet :

• model-template : nom du paquet npm / nom du repository GitHub
• publicodes : nom d'utilisateur GitHub / organisation GitHub

Pour utiliser les fonctionnalités de la CI :

1. Il faut décommenter les fichiers ./github/workflows/*.yaml
2. Ajouter les variables suivantes dans les secrets du repository GitHub : - NPM_TOKEN : token NPM pour publier le paquet sur npmjs.com - PAT : Personal Access Token pour publier la documentation sur GitHub Pages
3. Aller dans les paramètres du repository GitHub et : - modifier les droits des worflows - sélectionner la branche gh-pages dans les paramètres du repository

Exemples de dépôts utilisant ce template

• @incubateur-ademe/publicodes-commun - Ensemble de règles communes utilisées pour l'implémentation des modèles Publicodes de l'incubateur
• @incubateur-ademe/publicodes-negaoctet - Modèle Publicodes pour la base de données NegaOctet
• @incubateur-ademe/publicodes-impact-livraison - Modèle Publicodes pour le simulateur Impact Livraison
• ekofest/publicodes-evenements - Modèle Publicodes pour le calcul de l'impact environnemental des événements

Usage

Ajouter le paquet à vos dépendances :

yarn add model-template

Instancier un nouveau moteur Publicode :

import Engine from "publicodes"
import rules from "model-template"

const engine = new Engine(rules)

engine.evaluate("dépenses primeur")

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

importer!:
  depuis:
    nom: model-template
    url: https://github.com/publicodes/model-template
  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

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