Ecobalyse

Accélerer la mise en place de l'affichage environnemental

L'application est accessible à cette adresse.

Note: le projet Ecobalyse s'appellait initialement Wikicarbone.

Socle technique et prérequis

Cette application est écrite en Elm. Vous devez disposer d'un environnement NodeJS 14+ et npm, ainsi que d'un environnement python >=3.11 et pipenv sur votre machine :

Installation

Ensure having a PostgreSQL >=16 server running locally.

$ npm install
$ pipenv install

Pour initialiser la base de données (attention, toutes les données présentes, si il y en a, seront supprimées) :

$ npm run backend:start

Configuration

Les variables d'environnement suivantes doivent être définies :

• BACKEND_ADMINS : la liste des emails des administrateurs initiaux, séparés par une virgule
• DEFAULT_FROM_EMAIL : l'email utilisé comme origine pour les mails liés à l'authentification (par défaut ecobalyse@beta.gouv.fr)
• DJANGO_DEBUG: la valeur du mode DEBUG de Django (par défaut False)
• DJANGO_SECRET_KEY : la clé secrète de Django
• EMAIL_HOST : le host SMTP pour envoyer les mail liés à l'authentification
• EMAIL_HOST_USER: l'utilisateur du compte SMTP
• EMAIL_HOST_PASSWORD : le mot de passe du compte SMTP pour envoyer les mail liés à l'authentification
• MATOMO_HOST: le domaine de l'instance Matomo permettant le suivi d'audience du produit (typiquement stats.beta.gouv.fr).
• MATOMO_SITE_ID: l'identifiant du site Ecobalyse sur l'instance Matomo permettant le suivi d'audience du produit.
• MATOMO_TOKEN: le token Matomo permettant le suivi d'audience du produit.
• NODE_ENV: l'environnement d'exécution nodejs (par défaut, production)
• SCALINGO_POSTGRESQL_URL : l'uri pour accéder à Postgresl (définie automatiquement par Scalingo). Si non défini sqlite3 est utilisé.
• SENTRY_DSN: le DSN Sentry à utiliser pour les rapports d'erreur.

En développement, copiez le fichier .env.sample, renommez-le .env, et mettez à jour les valeurs qu'il contient ; le serveur de développement node chargera les variables en conséquences.

Développement

Environnement de développement local

Le serveur local de développement se lance au moyen des deux commandes suivantes :

$ npm start

Trois instances de développement sont alors accessibles :

• localhost:8002 sert le backend django utilisé pour l'authentification, et sert aussi les fichiers statiques de elm. Sert aussi l'admin django
• localhost:8001 sert l'API ;
• localhost:1234 est l'URL à utiliser en développement pour tester l'intégration des trois composants (le front, l'API et le Django) car un proxy Parcel renvoie certaines requêtes vers le port 8001 ou 8002 (voir .proxyrc). Le frontend est servi en mode hot-reload, pour recharger! l'interface Web à chaque modification du code frontend.

Hooks Git avec Husky et Formatage de Code avec Prettier

Ce projet utilise Husky pour gérer les hooks Git, et Prettier pour le formatage automatique du code. Le build sur le CI échouera si les fichiers javascript et json ne sont pas proprement formattés.

Pré-requis

• Husky
• Prettier

Si vous clonez le dépôt pour la première fois, les dépendances devraient être installées automatiquement après avoir exécuté npm install. Si ce n'est pas le cas, vous pouvez les installer manuellement.

$ npm install --save-dev husky prettier

Vérification Automatique avant chaque Commit

Un hook de pre-commit a été configuré pour vérifier que le code est bien formaté avant de permettre le commit. Si le code n'est pas correctement formaté, le commit sera bloqué.

Pour résoudre ce problème, vous pouvez exécuter la commande suivante :

$ npm run format:json

Si vous ne souhaitez pas que la vérification se fasse de manière automatique, vous pouvez désinstaler les hooks :

$ npx husky uninstall

Compilation

Pour compiler la partie client de l'application :

$ npm run build

Les fichiers sont alors générés dans le répertoire build à la racine du projet, qui peut être servi de façon statique.

Déploiement

L'application est déployée automatiquement sur la plateforme Scalingo à chaque mise à jour de la branche master sur le dépôt.

Chaque Pull Request effectuée sur le dépôt est également automatiquement déployée sur une instance de revue spécifique, par exemple https://ecobalyse-pr44.osc-fr1.scalingo.io/ pour la pull request #44. Ces instances de recette restent actives 72 heures, puis sont automatiquement décommisionnées passé ce délai ou si la pull request correspondante est mergée.

Serveur de production

Variables d'environnement

Les variables d'environnement doivent être positionnées via l'interface de configuration Scalingo (voir la section Configuration).

Lancement du serveur

Pour lancer le serveur applicatif complet (frontend + backend), par exemple depuis un environnement de production, la démarche est la suivante :

$ npm run build
$ npm run server:start

L'application est alors servie sur le port 1234.

Ecobalyse data

Ce dépôt contient aussi les scripts (principalement python) utilisés pour importer et exporter les données du projet Ecobalyse.

Ces scripts se trouvent dans data/, et un fichier README spécifique en détaille l'installation et l'utilisation.