20250109 add help section (#75)

* readme that works * help on top, documentation in the footer * script(format): run prettier --------- Co-authored-by: felhix <[email protected]> Co-authored-by: rebeccadumazert <[email protected]> Co-authored-by: Rebecca Dumazert <[email protected]>
numerique-gouv · Jan 10, 2025 · 791f4d3 · 791f4d3
1 parent 4009005
commit 791f4d3
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,42 @@
 # ProConnect BONJOUR
 
-## Lancer ce site localement
+## 1. Lancer ce site localement
 
-Vous devez avoir npm installé sur votre machine.
+Vous devez avoir npm et redis installés sur votre machine.
 
-```
+### 1.1. Télécharger le repo
+
+```sh
 git clone https://github.com/betagouv/proconnect-landing-page
 cd proconnect-landing-page
+```
+
+### 1.2. Créer un `.env`
+
+Il faut un fichier `.env` (gitignoré) pour rendre le répo fonctionnel :
+
+```sh
+cp .env.example .env
+```
+
+### 1.3. Faire les NPM installations
+
+```sh
 npm install
+npm run build
+```
+
+### 1.4. Lancer les serveurs
+
+Dans une fenêtre :
+
+```sh
 npm run dev
+```
+
+Dans une autre fenêtre :
+
+```sh
 npm run start:front
 ```
 
@@ -18,7 +46,7 @@ http://localhost:3001
 Welcome on localhost client :
 http://localhost:5173
 
-# Package Scripts
+## 2. Package Scripts
 
 | Command               | Description                  |
 | :-------------------- | :--------------------------- |

diff --git a/src/client/src/components/Footer/Footer.tsx b/src/client/src/components/Footer/Footer.tsx
@@ -17,8 +17,11 @@ function Footer() {
         <a href="/cgu#url-anchor-dp" className="fr-footer__bottom-link">
           Données personnelles
         </a>,
-        <a href="/cgu#url-anchor-gdc" className="fr-footer__bottom-link">
-          Gestion des cookies
+        <a
+          href="https://github.com/numerique-gouv/proconnect-documentation?tab=readme-ov-file#-proconnect---documentation"
+          className="fr-footer__bottom-link"
+        >
+          Intégrer ProConnect
         </a>,
         <a href="/cgu" className="fr-footer__bottom-link">
           Conditions générales d'utilisation

diff --git a/src/client/src/components/Header/Header.tsx b/src/client/src/components/Header/Header.tsx
@@ -8,11 +8,11 @@ function Header() {
   const isConnected = !!userInfo;
   const quickAccessItems = [
     {
-      iconId: "fr-icon-code-s-slash-line" as const,
+      iconId: "fr-icon-question-line" as const,
       linkProps: {
-        to: "https://github.com/numerique-gouv/agentconnect-documentation/blob/main/README.md#-agentconnect---documentation",
+        to: "https://agentconnect.crisp.help/fr/",
       },
-      text: "Intégrer ProConnect",
+      text: "Aide",
     },
     {
       iconId: "fr-icon-timer-line" as const,