Skip to content

Commit

Permalink
📝 docs: Add readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
Fabien authored and fabiengo committed Jan 6, 2025
1 parent b30796f commit c57bd21
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 37 deletions.
9 changes: 9 additions & 0 deletions dossierfacile-api-owner/README.md
Original file line number Diff line number Diff line change
@@ -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
14 changes: 14 additions & 0 deletions dossierfacile-api-tenant/README.md
Original file line number Diff line number Diff line change
@@ -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).
11 changes: 9 additions & 2 deletions dossierfacile-common-library/README.md
Original file line number Diff line number Diff line change
@@ -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.
## 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
41 changes: 6 additions & 35 deletions dossierfacile-pdf-generator/README.md
Original file line number Diff line number Diff line change
@@ -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: <code> .m2/settings.xml</code>
```
<settings>
...
<servers>
<server>
<id>github</id>
<username>GITHUB_USERNAME</username>
<password>GITHUB_TOKEN</password>
</server>
</servers>
...
</settings>
```
## Fonctionnalités principales
- Conversion de documents et fichiers en PDF avec filigrane
- Génération de dossiers de location au format PDF
9 changes: 9 additions & 0 deletions dossierfacile-process-file/README.md
Original file line number Diff line number Diff line change
@@ -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
11 changes: 11 additions & 0 deletions dossierfacile-task-scheduler/README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit c57bd21

Please sign in to comment.