Commit 43c6720d authored by Anthony Gautreau's avatar Anthony Gautreau
Browse files

Fix docs

parent 016c671d

README.md

+14 −10
Original line number Diff line number Diff line
@@ -19,7 +19,8 @@ 
    - [4. Lancer le docker](#4-lancer-le-docker)

- [Utilisation](#utilisation)

    - [Créer et supprimer des utilisateurs](#créer-et-supprimer-des-utilisateurs)

    - [Importer les données APOGEE dans l'API](#importer-les-données-apogee-dans-lapi)

    - [Importer les données APOGEE dans smile-connect](#importer-les-données-apogee-dans-smile-connect-manuellement)

- [Autres](#autres)

- [Contribution](#contribution)



# Smile-connect
@@ -101,13 +102,12 @@ Ce document décrit les exigences pour que l'importation de données fonctionne 


L'importation de données repose sur plusieurs fichiers SQL :



- `request_composantes.sql` : Ce fichier doit contenir des requêtes SQL pour récupérer les données de composantes de la base de données APOGEE.

- `request_formation.sql` : Ce fichier doit contenir des requêtes SQL pour récupérer les données de formations de la base de données APOGEE.

- `request_cour.sql` : Ce fichier doit contenir des requêtes SQL pour récupérer les données de cours de la base de données APOGEE.

- `api/data/request_composantes.sql` : Ce fichier doit contenir des requêtes SQL pour récupérer les données de composantes de la base de données APOGEE.

- `api/data/request_formation.sql` : Ce fichier doit contenir des requêtes SQL pour récupérer les données de formations de la base de données APOGEE.

- `api/data/request_cour.sql` : Ce fichier doit contenir des requêtes SQL pour récupérer les données de cours de la base de données APOGEE.



Il est préférable pour la visibilité de Smile de n'importer qu'un catalogue de cour utilisé en mobilité et pas l'intégralité de l'offre de formation.



Ces fichiers doivent être situés dans le répertoire `data` du projet.



#### Propriétés des données
@@ -130,8 +130,8 @@ Note : Les propriétés non obligatoires peuvent être omises, mais il est préf 
|--------------------------|----------|-------------|-----------------|-----------------|

| `COD_VET`                | `string` | Oui         | Code formation  |                 |

| `COD_CMP`                | `string` | Oui         | Code composante |                 |

| `LIB_WEB_VET`            | `string` | Non         |                 |                 |

| `TYPE_FORMATION`         | `string` | Non         |                 | L, M, etc       |

| `LIB_WEB_VET`            | `string` | Non         | Libelle         |                 |

| `TYPE_FORMATION`         | `string` | Non         |                 | L, M...         |

| `LIBELLE_TYPE_FORMATION` | `string` | Non         |                 | Licence, Master |

| `NIVEAU_FORMATION`       | `int`    | Non         |                 |                 |
@@ -147,7 +147,7 @@ Note : Les propriétés non obligatoires peuvent être omises, mais il est préf 
| `LIB_CMT_ELP`         | `string` | Non         | Libelle/Commentaires anglais |

| `S1`                  | `string` | Non         | "S1" ou vide ou boolean      |

| `S2`                  | `string` | Non         | "S2" ou vide ou boolean      |

| `LANGUE_ENSEIGNEMENT` | `string` | Non         |                              | |

| `LANGUE_ENSEIGNEMENT` | `string` | Non         | Français, Anglais, etc       | |

| `NBR_VOL_ELP`         | `string` | Non         | Volume horaire               |



Assurez-vous que les requêtes SQL dans les fichiers SQL récupèrent des données avec ces propriétés.
@@ -227,14 +227,18 @@ docker exec -it smile-connect-php bin/console app:create-user username password 
docker exec smile-connect-php bin/console app:delete-user username

```



### Importer les données APOGEE dans l'API

### Importer les données APOGEE dans smile-connect manuellement



Pour importer les données APOGEE dans l'API, vous pouvez utiliser la commande `bin/console app:import-data`.

Pour importer les données APOGEE dans smile-connect, vous pouvez utiliser la commande `bin/console app:import-data` si vous avez configuré les requêtes.



```bash

docker exec smile-connect-php bin/console app:import-data

```



### Autres



Vous pouvez directement mettre à jour les tables de la base Postgresql avec vos propres moyens pour rendre accessible votre ODF à l'API.



## Contribution



Les contributions sont les bienvenues ! Veuillez créer une issue ou une pull request pour toute contribution que vous souhaitez apporter.