From c57bd216e435e8d61411725a6d214e83f38bc343 Mon Sep 17 00:00:00 2001 From: Fabien Date: Thu, 2 Jan 2025 18:26:36 +0100 Subject: [PATCH] :memo: docs: Add readme files --- dossierfacile-api-owner/README.md | 9 ++++++ dossierfacile-api-tenant/README.md | 14 +++++++++ dossierfacile-common-library/README.md | 11 +++++-- dossierfacile-pdf-generator/README.md | 41 ++++---------------------- dossierfacile-process-file/README.md | 9 ++++++ dossierfacile-task-scheduler/README.md | 11 +++++++ 6 files changed, 58 insertions(+), 37 deletions(-) create mode 100644 dossierfacile-api-owner/README.md create mode 100644 dossierfacile-api-tenant/README.md create mode 100644 dossierfacile-process-file/README.md create mode 100644 dossierfacile-task-scheduler/README.md diff --git a/dossierfacile-api-owner/README.md b/dossierfacile-api-owner/README.md new file mode 100644 index 000000000..866695089 --- /dev/null +++ b/dossierfacile-api-owner/README.md @@ -0,0 +1,9 @@ +# API Propriétaire (dossierfacile-api-owner) + +## Description +API REST dédiée à l'espace propriétaires, permettant la gestion et la consultation des dossiers des locataires. + +## Fonctionnalités principales +- Création et gestion des comptes propriétaires +- Partage de ses propriétés avec les candidats locataires +- Consultation des dossiers partagés par les locataires \ No newline at end of file diff --git a/dossierfacile-api-tenant/README.md b/dossierfacile-api-tenant/README.md new file mode 100644 index 000000000..eed8c9677 --- /dev/null +++ b/dossierfacile-api-tenant/README.md @@ -0,0 +1,14 @@ +# API Locataire (dossierfacile-api-tenant) + +## Description +API REST dédiée aux locataires, permettant la gestion des dossiers de location. +API REST dédiée aux utilisateurs de DossierFacile (DFC), permettant la visualisation des informations des locataires. + +## Fonctionnalités principales +- Création et gestion de comptes locataires +- Téléversement et gestion des justificatifs +- Création et modification de dossiers +- Partage de dossiers + +## Documentation de l'API DFC +La documentation Swagger est accessible [ici](https://api-preprod.dossierfacile.fr/swagger-ui/index.html?urls.primaryName=API%20DFC). \ No newline at end of file diff --git a/dossierfacile-common-library/README.md b/dossierfacile-common-library/README.md index 752b99ac9..083874315 100644 --- a/dossierfacile-common-library/README.md +++ b/dossierfacile-common-library/README.md @@ -1,3 +1,10 @@ -# DossierFacile-common-library +# Bibliothèque commune (dossierfacile-common-library) -This project contains shared models, repositories, mappers, services, ... used by Dossier-Facile's services. \ No newline at end of file +## Description +Bibliothèque partagée contenant les composants communs utilisés par les différents services du projet. + +## Composants principaux +- Entités JPA communes +- Services partagés +- Configurations communes +- Ressources utilitaires \ No newline at end of file diff --git a/dossierfacile-pdf-generator/README.md b/dossierfacile-pdf-generator/README.md index 822e1c9db..472569f0d 100644 --- a/dossierfacile-pdf-generator/README.md +++ b/dossierfacile-pdf-generator/README.md @@ -1,37 +1,8 @@ -# Dossier-Facile-Pdf-Generator -Dossier Facile PDF Generator +# Générateur de fichiers PDF (dossierfacile-pdf-generator) +## Description +Service dédié à la génération de documents PDF. -# Install and run - -To build: `mvn clean install` -To run: `mvn spring-boot:run ` - -## Requirements -- running DossierFacile database -- running rabbitMQ service - -## Configure - -We use Github package to store common library `dossierfacile-common-library` . -Thus you need to authenticate yourself to get it on github package. - -Configure the following environement variables: -``` -GITHUB_USERNAME -GITHUB_TOKEN -``` -Or use your global maven settings: .m2/settings.xml -``` - - ... - - - github - GITHUB_USERNAME - GITHUB_TOKEN - - - ... - -``` \ No newline at end of file +## Fonctionnalités principales +- Conversion de documents et fichiers en PDF avec filigrane +- Génération de dossiers de location au format PDF \ No newline at end of file diff --git a/dossierfacile-process-file/README.md b/dossierfacile-process-file/README.md new file mode 100644 index 000000000..35c24221a --- /dev/null +++ b/dossierfacile-process-file/README.md @@ -0,0 +1,9 @@ +# Service de traitement asynchrone des fichiers et docuemnts (dossierfacile-process-file) + +## Description +Service responsable du traitement asynchrone des documents et des fichiers. + +## Fonctionnalités principales +- Miniaturisation des fichiers +- Extraction des données (OCR, lecture 2D Doc, ...) +- Analyse des documents \ No newline at end of file diff --git a/dossierfacile-task-scheduler/README.md b/dossierfacile-task-scheduler/README.md new file mode 100644 index 000000000..1f5dc7f61 --- /dev/null +++ b/dossierfacile-task-scheduler/README.md @@ -0,0 +1,11 @@ +# Service de gestion des tâches asynchrones (dossierfacile-task-scheduler) + +## Description +Module responsable de la planification et de l'exécution des tâches récurrentes dans DossierFacile. + +## Tâches principales +- Vérification de la disponibilité de l'API de l'ADEME +- Gestion des documents en erreur dans les dossiers (tentative de génération, suppression) +- Gestion de la synchronisation des fichiers sur les stockages +- Nettoyage des fichiers sur les stockages +- Gestion des opérations asynchrones sur les comptes (messages de warning, archivage, suppression)