doc: améliore le README

suppression-manon-adrien
Sébastien Arod 2024-10-10 14:04:29 +02:00
parent f950805d8e
commit f5063f4771
1 changed files with 2 additions and 1 deletions

View File

@ -12,6 +12,7 @@ La liste est embarquée dans le site global squarespace à deux endroits:
# Installation de l'environement de dev # Installation de l'environement de dev
- Installer vscode (https://code.visualstudio.com/) + les extensions recommandés - Installer vscode (https://code.visualstudio.com/) + les extensions recommandés
- Installer git (https://git-scm.com/downloads)
- Installer la version LTS de node (https://nodejs.org/en) - Installer la version LTS de node (https://nodejs.org/en)
- Installer yarn (https://yarnpkg.com/getting-started/install) - Installer yarn (https://yarnpkg.com/getting-started/install)
- Checkout du repository git depuis framagit - Checkout du repository git depuis framagit
@ -32,7 +33,7 @@ On ajoute les familles après leur annonce sur Discord.
- `noms`: les noms complets des parents au format `Prénom1 Nom1 et Prénom2 Nom2` ou `Prénom1 et Prénom2 NomCommun` - `noms`: les noms complets des parents au format `Prénom1 Nom1 et Prénom2 Nom2` ou `Prénom1 et Prénom2 NomCommun`
- `enfants`: Prénoms des enfants au format `Enfant 1, Enfant 2 et Enfant 3` - `enfants`: Prénoms des enfants au format `Enfant 1, Enfant 2 et Enfant 3`
- `departement`: Département parmi la liste de valeur défini dans le `type Departement` dans le fichier [src/Resistant.ts](src/Resistant.ts). Si le département manque dans la liste il faut le rajouter. - `departement`: Département parmi la liste de valeur défini dans le `type Departement` dans le fichier [src/Resistant.ts](src/Resistant.ts). Si le département manque dans la liste il faut le rajouter.
- `presentation`: Le text de presentation pour le site web. A prendre depuis le contenu de la page notion. ⚠️ Il est souvent nécessaire de nettoyer les fins de lignes et saut de ligne sur le contenu Notion. (https://jsstringconverter.bbody.io/ peut-être utilisé pour convertir le textet en string js, il faut cocher `Add Newlines` et mettre `Variable Name` à vide) - `presentation`: Le text de presentation pour le site web. A prendre depuis le contenu de la page notion. ⚠️ Il est souvent nécessaire de nettoyer les fins de lignes et saut de ligne ainsi que les points médian sur le contenu Notion. (https://jsstringconverter.bbody.io/ peut-être utilisé pour convertir le textet en string js, il faut cocher `Add Newlines` et mettre `Variable Name` à vide)
- `latitude` & `longitude`: à déterminer avec google maps à partir de la ville de la famille et prendre dans l'url les 2 elements qui suivent le @ par exemple pour [Lyon](https://www.google.fr/maps/place/Lyon/@45.7579507,4.8351301,18724m/data=!3m2!1e3!4b1!4m6!3m5!1s0x47f4ea516ae88797:0x408ab2ae4bb21f0!8m2!3d45.764043!4d4.835659!16zL20vMGRwcmc?hl=fr&entry=ttu&g_ep=EgoyMDI0MDkyMy4wIKXMDSoASAFQAw%3D%3D) les latitude et longitude sont 45.7580409 et 4.752729 - `latitude` & `longitude`: à déterminer avec google maps à partir de la ville de la famille et prendre dans l'url les 2 elements qui suivent le @ par exemple pour [Lyon](https://www.google.fr/maps/place/Lyon/@45.7579507,4.8351301,18724m/data=!3m2!1e3!4b1!4m6!3m5!1s0x47f4ea516ae88797:0x408ab2ae4bb21f0!8m2!3d45.764043!4d4.835659!16zL20vMGRwcmc?hl=fr&entry=ttu&g_ep=EgoyMDI0MDkyMy4wIKXMDSoASAFQAw%3D%3D) les latitude et longitude sont 45.7580409 et 4.752729
- `date_declaration`: à prendre dans la preuve d'envoi du courrier de DC ou à defaut dans le corps du courrier ou à défaut la date d'intégration dans notion au format YYYY-MM-DD. - `date_declaration`: à prendre dans la preuve d'envoi du courrier de DC ou à defaut dans le corps du courrier ou à défaut la date d'intégration dans notion au format YYYY-MM-DD.
- `mention`: mention additionnelle. Laissé vide la plupart du temps. - `mention`: mention additionnelle. Laissé vide la plupart du temps.