README.md

Territoires en Transition

Dans le cadre des programmes d'accompagnement des collectivités dans leurs démarches de transition écologique, l'ADEME (l'Agence de la transition écologique) s'est associée à beta.gouv.fr.

L'objectif : Aider les collectivités à prioriser la mise en œuvre des actions les plus impactantes pour réussir la transition écologique.

Description du service

Une transition écologique lente et complexe

Les collectivités ont un rôle central à jouer dans la transition écologique. Elles possèdent les compétences et l'influence sur de nombreuses activités déterminantes pour la réussite de la transition écologique.

Une majorité des collectivités rencontrent des difficultés à mettre en place des actions à la hauteur des enjeux sur leur territoire. Au-delà des différents blocages politiques, organisationnels et financiers, ces difficultés sont directement liées à la complexité et transversalité des sujets de la transition écologique qui, pourtant, dans leur mise en oeuvre, ne sont portés que par quelques personnes au sein de la collectivité.

Faciliter et accélérer la mise en oeuvre des actions de transition écologique

La plateforme numérique a pour objectifs de faciliter et d'accélérer la mise en oeuvre des actions ayant le plus d'impact pour la réussite de la transition écologique au sein d'une interface permettant :

• D'accéder aux référentiels d'actions de transition écologique CAE (Climat-Air-Énergie, aussi connu comme la labellisation Cit'ergie) et ECI (Économie Circulaire) et de personnaliser leur utilisation
• De gérer et suivre ses actions et indicateurs de transition écologique
• De prioriser les actions ayant le plus d'impact
• De partager la progression des réalisations et des retours d'expériences entre collectivités

Documentation

La documentation technique du projet utilise le format Architecture Decision Record (ADR), basé sur le template par défaut du CLI adr-tools.

Organisation du dépôt

Ce dépôt Git contient :

• 3 services :
  • le "data-layer"
  • le "business"
  • le client
• les données des référentiels en markdown
• le code du site statique
• les composants partagés entre le client et le site

Chaque dossier à la racine contient son propre README.md et peut a priori fonctionner de manière autonome.

Vous pouvez contribuer à notre projet en suivant cette documentation.

Conception

La conception, des données au choix de la stack.

Données

Les données métier

Les contenus de notre application sont écrits en markdown, ce faisant les experts métiers travaillent dans le même dépôt que les devs.

Ces fichiers markdowns représentent des définitions auxquelles sont rattachées des données provenant d'utilisateurs. Par exemple un indicateur tel que Emissions de GES est destiné à permettre aux utilisateurs à saisir leurs données annuelles dans notre application.

Ces définitions sont lues par la partie referentiel du business et sauvegardée en base afin d'être

• utilisées pour le processus d'évaluation
• affichées dans le client
• utilisées comme garantie de la cohérence des données utilisateur stockées dans le data layer

Les données utilisateurs

Les utilisateurs saisissent pour le compte de leur collectivité des données qui sont stockées dans le data layer qui vérifie leurs droits en écriture grace aux row security policies

Les données d'évaluation

Les données utilisateurs rattachées aux référentiels sont évaluées par le service évaluation du business qui inscrit les résultats en base et les transmets au client via les WebSockets de supabase realtime

Design

L'application est composée de trois éléments : le client, le data layer et le business.

Chacun de ses éléments a un périmètre définit :

• le client permet aux utilisateurs de se servir du produit et ne communique qu'avec le data layer
• le data layer se charge des données et de l'authentification.
  • Il permet au client de stocker les données de façon sécurisé et lui fournit les moyens via une API REST de lire les données simplement en lui fournissant des endpoints adaptés.
  • Il permet au business de stocker les données métier et d'accéder aux données utilisateurs
  • Dans le processus d'évaluation, il permet au business de réagir aux changements des données utilisateur et au client de réagir aux changements des évaluations.
  • Enfin, il garantit la cohérence des données.
• le business se charge des parties métier et ne communique qu'avec le data layer
  • il lit les contenus markdown et les enregistre dans le data layer
  • il évalue les données utilisateur et les enregistre dans le data layer

Stack

• Le client utilise React ce qui nous permet de bénéficier d'un écosystème riche. Il est développé en TypeScript.

• Le data layer utilise Supabase, une solution qui intègre tous les services dont nous avons besoin en open source dont :

  • gotrue pour l'authentification OAuth2
  • PostgreSQL la base qui nous apporte le typage et la consistence des données.
  • PostgREST qui transforme la base de donnée en une API RESTful.

• le business est développé en Python 🐍.

Lancer le projet en local pour le développement

Dépendances

• Docker, permet de lancer les conteneurs qui composent le produit. Installation simple avec Docker Desktop.
• Earthly qui permet de lancer le projet et la CI en local comme en remote.
• Supabase CLI pour lancer le datalayer et générer les types.

Set up

Une fois les dépendances il suffit de lancer la commande setup-env avec earthly pour configurer les variables d'environnement de chaque projet.

earthly +setup-env

Lancer les différents services en local

Pour lancer les services en local avec docker, on utilise la commande dev :

earthly +dev

Par default le client (app) n'est pas lancé, on peut néanmoins spécifier les options suivantes :

• stop : commence par stopper les services.
• datalayer : lance supabase.
• business : build et lance le business.
• app : build et lance l'app

On peut écrire par exemple :

earthly +dev --stop=yes --datalayer=yes --business=yes --app=no

Lancer les tests

Les trois services sont des projets indépendants qui peuvent-être testés en local sous reserve que les dépendances de développement soient installées.

Néanmoins, on peut lancer les tests avec earthly en utilisant des conteneurs :

# Lance le projet suivi de tout les tests.
earthly +dev

# Lance les tests indépendamment
earthly --push +db-test
earthly --push +business-test
earthly --push +app-test
earthly --push +api-test
earthly --push +deploy-test

Déploiement

Aujourd'hui le business et le client sont déployés chez Scalingo, le data layer est chez Supabase en mode BaaS.

Workspaces NPM

Les workspaces NPM sont utilisés pour partager du code entre différents modules front du projet (ui, app et site).

Tous les modules du projet utilisent l'espace de nommage @tet (exemple: @tet/app pour l'application).

Les chemins des workspaces sont listés dans la propriétés workspaces du fichier package.json à la racine du dépôt.

Dans ce contexte les différentes commandes NPM habituelles peuvent être lancées depuis le répertoire racine en précisant avec l'option -w (ou --workspace) le(s) workspace(s) dans le(s)quel(s) la commande doit s'exécuter.

Exemples :

• Installer les dépendances pour les modules ui et site : npm i -w @tet/ui -w @tet/site

• Ajouter une dépendance externe dans le module app : npm i <nom-module-npm-externe> -w @tet/app

• Ajouter une dépendance interne dans le module app : npm i @tet/<nom-module-interne> -w @tet/app

• Lancer le serveur de développement du module ui : npm run dev -w @tet/ui

Les modules site et app étant dépendants du module partagé ui, des commandes permettant de lancer en parallèle les serveurs de développement sont disponibles à la racine du projet.

• Démarrer les serveurs de dev ui et app : npm run dev:app

• Démarrer les serveurs de dev ui et site : npm run dev:site

• Démarrer les serveurs de dev ui, app et site : npm run dev

De la même manière pour faire le build de production du site et de l'app il faut aussi faire le build des modules partagés.

• Faire le build de production de app : npm run build:app

• Faire le build de production de site : npm run build:site

Enfin pour faire le build depuis Scalingo la variable d'environnement SCALINGO_BUILD est attendue pour contrôler le fonctionnement de la commande npm run build.

• Lorsque la variable est renseignée, les dépendances nécessaires au build sont installées.

• Lorsque la variable vaut site, la commande build:site est lancée, et sinon la commande build:app.