Documentation fonctionnelle

Setup du projet

Nous avons mis en place un docker qui sera instancié via le fichier ".env"

Afin de le déployer il faut :

• Installer docker
• Créer le fichier .env dans la racine du projet et éditer la configuration :

SPRING_PROFILES_ACTIVE=local
DB_USERNAME= # Ex : postgres
DB_PASSWORD= # Ex : admin
DB_NAME= # Ex : MySurvey
DB_URL="jdbc:postgresql://db:5432"
ADMINER_PORTS= # Ex : 8081
DB_PORTS= # Ex : 5432
SERVER_PORT= # Ex : 8090

DB_USERNAME : le login avec lequel vous accèderez à la base DB_PASSWORD : le mot de passe avec lequel vous accèderez à la base DB_NAME : le nom de la base ADMINER_PORTS : le port d'entrée de la base adminer DB_PORTS : le port d'entrée de la base PostgreSQL SERVER_PORT : le port d'entrée du serveur

Dans le fichier Dockerfile, il faut modifier la variable EXPOSE par le port voulu pour l'exécution de l'application.

• Dans un terminal (CMD ou Powershell), placez vous à la racine du projet et exécutez la commande docker-compose up --build

Tests du projet

Pour lancer les tests du projet, utilisez la commande : mvn test

Lancer le projet

Pour lancer le projet il faut exécuter le fichier MySurveyApplication

• Accès à l'api Swagger : http://localhost/:{ VOTRE_SERVER_PORT }/swagger-ui.html (dépend du SERVER_PORT que vous avez set dans .env)
• Documentation de l'api : http://localhost/:{ VOTRE_SERVER_PORT }/v3/api-docs (dépend du SERVER_PORT que vous avez set dans .env)
• Interface adminer pour consulter la DB : http://localhost/:{ VOTRE_SERVER_PORT }/ (dépend du SERVER_PORT que vous avez set dans .env)

Accès en ligne

Voici un lien pour y accéder : https://sondage.ronde-lingons.fr/swagger-ui.html