@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

# installe les dépendances
yarn install

# compile le modèle publicodes en un fichier JSON et lance la documentation (mode watch)
yarn dev

Publier une nouvelle version

Afin de publier une nouvelle version il suffit d'exécuter la commande npm version, pour créer un commit avec la nouvelle version dans le package.json et faire un tag git.

# prochaine version v0.X.0
npm version minor

Il ne reste alors plus qu'à pousser le commit et le tag pour créer une release sur le registre NPM.

git push && git push --tags

Détail des commandes

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 (non utilisé)

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