docs: add README.md

README.md

@@ -0,0 +1,58 @@
+# Description
+
+La liste des résistants enfance libre est gérée par le code dans ce repo git.
+
+Ce code gère la liste des résistants en vue carte, vue liste, vue photo et en vue détaillée.
+
+La liste est embarquée dans le site global squarespace par iframe à deux endroits:
+* Sur la home page (https://www.enfance-libre.fr/) 
+* Sur la page résistants (https://www.enfance-libre.fr/resistants).
+
+Avec 2 différences  :
+* La taille d’iframe
+* Le mode par défaut du composant liste: qui est en mode carte sur la home page et liste sur la page résistants
+
+
+# Ajouter une famille
+
+## Quelles familles ajouter
+
+Notion contient une [Liste des Familles à ajouter sur le site](https://www.notion.so/5b69e02b296d4a578f8c8ab7fe8b05da?v=bd01159ed0bb42fa9dd16caa1fba93e7)
+
+## Modifier le code pour ajouter une famille
+
+* Ajouter la famille dans la liste des résistants dans le fichier [src/resistants.ts] en prenant les informations depuis Notion
+  * `id`: basé sur les noms des parents sans accents au format <prenom1-prenom2> ou <prenom-nom> pour les familles monoparentale
+  * `noms`: les noms complets des parents au format <Prénom Nom et Prénom Nom>
+  * `enfants`: Prénoms des enfants
+  * `departement`: Département parmi la liste de valeur défini dans le `type Departement` dans le fichier [src/Resistant.ts]. Si le département manque dans la liste il faut le rajouter. 
+  * `academie`: Académie parmie la liste de valeur défini dans le `type Academie` dans le fichier [src/Resistant.ts]. Si l'académie manque dans la liste il faut la rajouter. 
+  * `presentation`: La presentation pour le site web. A prendre depuis le contenu de la pge notion. ⚠️ Il est souvent nécessaire de nettoyer les fins de lignes et saut de ligne.
+  * `latitude` & `longitude`: à déterminer avec google maps à partir de la ville de la famille.
+  * `date_declaration`: à prendre dans le courrier de déclaration
+  * `lien_declaration`: `getResistantDeclarationUrl(<id>)` id définit au dessus,
+  * `mention`: laissé vide la plupart du temps
+  * `video`: laissé vide la plupart du temps
+* Ajouter la photo 
+  * Ajouter la photo dans le répertoire [src/photos] avec le nom `<id>`.jpg
+  * Modifier [src/photos/index.ts] pour ajouter la ligne d’import de la photo
+* Ajouter la déclaration 
+  * Ajouter le pdg de la déclaration dans le répertoire src/déclarations avec le nom <id>.pdf
+  * Modifier src/déclarations/index.ts pour ajouter la ligne d’import de la photo
+
+
+## Vérifier les changements
+
+yarn dev peut être utilisé pour vérifier que le contenu pour la famille.
+* [http://localhost:5173/resistants/#/] permet de vérifier que la liste s’affiche bien
+* [http://localhost:5173/resistants/#/id] permet de vérifier que le détail d’une famille s’affiche bien
+
+⚠️Attention cependant:
+* les liens vers les assets (images et déclarations) pointent directement vers les assets de prod et donc l’image et la déclaration ne s’affiche pas correctement en locale pour les nouvelles familles ajouter localement.
+* la page détail s’affiche légèrement différemment (le css du site manque probablement)
+
+La vérification complète ne peut donc se faire qu’après publication.
+
+## Publier les changements
+* Commiter avec un commit message “feat: ajout de Prénom1 et Prénom2”
+* Le push vers main va déclencher la CI de mise à jour du site web.