DossierFacile.fr a été créé par le Ministère de la Transition écologique pour aider à la réalisation de dossiers de location.
The project is available at DossierFacile.fr.
The front-end code is also accessible in this repository.
You need to have JDK 21, maven and Docker installed.
In this project we use a Docker Compose to setup the dev environment. Several services are used:
- PostgreSQL => Database for all the applications
- NGINX => Reverse proxy for the BO to serve SSL
- RabbitMQ => Queue used by pdf-generator, api-tenant and api-watermark
Run:
docker-compose -f docker-compose.dev.yml up -d
To create a dedicated user and database for dossierfacile.
Follow those steps to use Keycloak in dev environment locally :
1 - Follow the README instructions on repo [Dossier-Facile-Keycloak](https://github.com/MTES-MCT/Dossier-Facile-Keycloak).
2 - Connect to your keycloak admin console (default : http://localhost:8085/auth)
3 - Create a new realm "dossier-facile"
4 - Inside the realm create a new Client scope :
- Name: dossier
- Type: Default
- Display on consent screen: On
- Include in token scope: On
5 - Inside the realm create a new client : "dossier-facile-frontend-localhost"
- Root: Url of the tenant webProject (default : http://localhost:8090)
- Home URL : Url of the tenant webProject (default: http://localhost:8090)
- valid redirect Uris : *
- Valid post logout Uris: *
- web Origins: *
- Client authentication : Off
- authentication flow: Standard flow and Direct access Grants
- Theme : df
- Client scopes : add dossier
6 - Create a new realm "dossier-facile-owner :
7 - Inside the realm create a new Client scope :
- Name: dossier
- Type: Default
- Display on consent screen: On
- Include in token scope: On
8 - Inside the realm create a new client : "dossier-facile-owner-localhost"
- Root: Url of the tenant webProject (default : http://localhost:8090)
- Home URL : Url of the tenant webProject (default: http://localhost:8090)
- valid redirect Uris : *
- Valid post logout Uris: *
- web Origins: *
- Client authentication : Off
- authentication flow: Standard flow and Direct access Grants
- Theme : df
- Client scopes : add dossier
9 - Inside the realm Master create a new client : "dossier-facile-api"
- Root: empty
- Home URL : empty
- valid redirect Uris : *
- Valid post logout Uris: *
- web Origins: *
- Client authentication : On
- authentication flow: Standard flow / Direct access Grants / Service account roles
10 - In this client you need add a Service account roles
- In the tab "Service Account Roles" add the role "admin"
Save and copy the dossier-facile-api credentials (Client Secret).
Create a new folder mock-storage to store files.
- Project : dossierfacile-api-owner
- Project : dossierfacile-api-tenant
- Project : dossierfacile-api-watermark
- Project : dossierfacile-bo
- Project : dossierfacile-pdf-generator
- Project : dossierfacile-process-file
- Project : dossierfacile-task-scheduler
Run mvn clean install from the root folder. This will build every module.
In each application folder, run
mvn spring-boot:run -D spring-boot.run.profiles=dev,mockOvh
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.