Merge pull request #2 from mrossard/doc-init

Ajout doc fonctionnelle

README.md

@@ -24,7 +24,14 @@ suivantes :
 * Backend : PHP, Symfony 7.1 / Api Platform 3.2
 
 Des Dockerfile sont fournis pour le déploiement des deux applications, plus de détails dans la documentation de
-chacune :
+chacune.
+
+## Documentation
+
+Les fonctionnalités de l'application sont documentée via
+l'[expression de besoins](docs/Documentation_Fonctionnelle_Oasis_1.0.pdf), remise à jour post développement.
+
+Des documentations techniques sont disponibles séparément pour les deux briques applicatives :
 
 * [frontend](docs/frontend/README.md)
 * [backend](docs/backend/README.md)

backend/fixtures/deploiement/utilisateurs_admins.yaml

@@ -5,21 +5,18 @@ App\Entity\Utilisateur:
     nom: 'ROSSARD'
     prenom: 'Manuel'
     admin: true
+    destinataire_technique: true
   jlemon100p:
     uid: 'jlemon100p'
     email: '[email protected]'
     nom: 'LEMONNIER'
     prenom: 'Julien'
     admin: true
-  axdubroca:
-    uid: 'axdubroca'
-    email: '[email protected]'
-    nom: 'DUBROCA'
-    prenom: 'Axelle'
+    destinataire_technique: true
+  admin_fonctionnel:
+    uid: 'admin-fonctionnel'
+    email: '[email protected]'
+    nom: 'FONCTIONNEL'
+    prenom: 'Admin'
     admin: true
-  kverdeau:
-    uid: 'kverdeau'
-    email: '[email protected]'
-    nom: 'VERDEAU'
-    prenom: 'Karine'
-    admin: true
+    destinataire_technique: false

docs/backend/README.md

@@ -124,7 +124,7 @@ $ docker run --add-host=host.docker.internal:ip.machine.dev \
 ```
 
 Au premier démarrage la base (qui doit être créée au préalable) sera initialisée automatiquement / mise à jour si
-nécessaire.  
+nécessaire.
 Pour le développement, vous pouvez créer et mettre à jour la base à la main après le premier démarrage du conteneur si
 vous le souhaitez (en ignorant les erreurs) :
 
@@ -133,6 +133,23 @@ $ php bin/console doctrine:database:create
 $ php bin/console doctrine:migrations:migrate
 ```
 
+### Données initiales
+
+Comme mentionné plus haut, la base de données est mise à jour / initialisée automatiquement au démarrage.
+
+Les données qui sont chargées à l'initialisation sont celles définies dans les fixtures du
+dossier [deploiement](../../backend/fixtures/deploiement). Les données livrées sont celles utilisées par l'université de
+Bordeaux, modifiez les en fonction de vos besoins !
+
+La commande exécutée pour l'initialisation des données peut être lancée à la main :
+
+```
+$ php bin/console app:init-db
+```
+
+Elle n'a cependant d'effet que s'il n'existe aucun utilisateur déclaré en base ; si vous voulez réinitialiser vos
+données via cette commande il faut repartir d'une base sans aucune données.
+
 ### Conseils pratiques
 
 L'application génère (si nécessaire) au démarrage des clés servant à signer les token JWT qu'elle émet. Ces clés sont