API pour modèle Publicodes de Nos Gestes Climat.
Schéma général de l'API :
https://nosgestesclimat-api.osc-fr1.scalingo.io/<version>/<langue>/<region>
Avec :
version- la version du modèle à utiliser, (latestpour la dernière version)langue- la langue à utiliser (frouen)region- la région à utiliser (FR,CA,BE,CH, etc...)/versions: retourne l'ensemble des versions du modèle/<version>:retourne les langues et régions supportées par la version<version><version>/<langue>/personas: retourne l'ensemble des personas du modèle<version>/<langue>/<region>/rules/- retourne l'ensemble des règles du modèle<version>/<langue>/<region>/optim-rules/- retourne l'ensemble des règles optimisées du modèle<version>/<langue>/<region>/rules/<rule>- retourne la règle{rule}du modèle
Le déploiement est fait automatiquement par
Scalingo à
chaque push sur la branche main.
Important
La mise à jours des version se fait via les GitHub Actions du dépôt
nosgestesclimat. En
particulier, à chaque :
- nouvelle release de
nosgestesclimat, une nouvelle branche est créée dans ce dépôt avec le nouveau dossierdata/<version>. Il ne restera plus qu'à la merge dansmainpour quelle soit automatiquement déployée sur Scalingo. - push dans dans la branche
preproddu dépôtnosgestesclimat, la versionnightlyest automatiquement mise à jours dansmainest déployée en prod.
npm est utilisé comme gestionnaire de paquets avec
bun comme runtime JS et
koa comme framework web.
# Installation des dépendances
npm i
# Lancement du serveur de développement
npm run dev # ou bun dev
# Lancement du serveur de production
npm start # ou bun start