README.md

Impact CO2

Application web sous Next.js permettant de comparer la consommation en CO2e de divers équivalents.

https://impactco2.fr

Installation 💾

yarn pour installer l'application

yarn dev pour lancer un serveur de développement sur http://localhost:3000

yarn build pour build l'application

yarn start pour lancer un serveur de production

Déploiement 🚀

Le site est hébergé sur Netlify via des serveurs en Europe. Aucune donnée ne transite en dehors de l’UE.

Développement ⚙️

L’organisation du développement suit le workflow Gitflow :

• La branche de production est master. Seul les releases et hotfix peuvent être mergées directement dans master. Elle est visible ici
• La branche de développement est develop. C’est sur cette branche qu’est visible le travail en cours. Elle est visible ici
• On crée une issue et une branche pour chaque nouvelle fonctionnalité (nom de la branche : numéro de l’issue associée). Cette branche utilise la branche develop comme parent. Elle donne lieu à une PR vers la branche develop (nom de la PR : [nom_de_lissue] (issue [numero_de_lissue])).
• À la fin de chaque cycle de développement, on crée une branche release à partir de develop. Cette branche est ensuite mergée dans master et tagguée avec un numéro de release.
• Les hotfix sont créé sur des branches dédiées (issues de master), associées ou non à une issue. Elles peuvent être mergées directement dans master.

Les commits sont conventionnés. Les types suivants sont acceptés :

• build
• docs
• feat
• fix
• perf
• refactor
• style
• test

Architecture 🏛️

Le projet utilise React avec (entre autre) Nextjs, React Query et Styled Components. Le state est simplement géré par Context.

Le repo est architecturé avec les dossiers suivants :

• pages avec l'ensemble des pages du site.
• src avec tout le reste du code.
  • components avec l'ensemble des composants
    • base avec les composants simple réutilisés partout (un peu comme les atomes pour l'atomic design)
    • charts avec les différents graphique utilisés sur le site
    • layout avec les composants de structure globale (header, footer, etc.)
    • misc avec les composants qui ne rentrent pas dans les autres dossier
    • modals avec les différentes modals utilisées sur le site (elles sont déclaré sur le site site via leur provider)
    • providers (qui pourrait être renommé context) avec les contexts et leur provider (dans le même fichier, ce sont les seuls composants qui ont deux exports)
    • screenshot avec tous les composants spécifiques à la prise de screenshots (boutons, signature, etc.)
    • views avec les composants spécifiques à une page
    • [categorie] certains dossiers portent le nom d’une catégorie. Ils contiennent tous l’affichage et la logique spécifique à cette catégorie (et ses équivalents). Ce qui inclue composants et context/provider. Seules les modals restent centralisées dans le dossier modals
  • data avec l'ensemble des données locales importées au build
  • hooks avec ...les hooks
  • utils avec quelques fonctions et les bases du css

Les composants (en dehors des providers et des modals) sont regroupés par feature. Chaque composant enfant est dans un dossier du nom du composant parent, à la racine du composant parent. Si un enfant à plusieurs parents, il migre dans le dossier misc. Si un groupe de composants dans le dossier misc devient suffisamment important pour mériter son propre dossier, il migre à la racine du dossier components, dans un dossier au nom approprié.

Chaque fichier de composant (sauf les providers) n'a qu'un seul export : le composant. L'intérieur de ce fichier est structuré comme suit :

• Import de librairie externes (React, Styled Components, etc.)
• Import de librairie interne (d'autres composants que l'on a créé)
• Déclaration des Styled-Components, par ordre d'apparition dans le composant
• Déclaration et export du composant

Les fonctions appelées dans le jsx ne sont pas nommées, afin de simplifier la lecture. On essaie de maintenir les fichiers de composants bien en dessous de 100 lignes