freelyforms_da50

mon projet de ses morts de da50 bisous bisous xoxo câlins et papouilles si consentis

Go to file

Chrysalis 4eed4ee0b6 Merge branch '#22_Documentation' into 'main' #22 - Adds complete documentation in Java project files, adds Javadoc for current version dev-0.1.0 See merge request freelyforms/freelyforms!10		2 years ago
.github/workflows	#20 - Added single database access. Fixed the project existing as two separate entities.	2 years ago
.mvn/wrapper	Initial commit	3 years ago
doc	#22 - Adds complete documentation in Java project files, adds Javadoc for current version dev-0.1.0	2 years ago
freelyforms-front	#20 - Added single database access. Fixed the project existing as two separate entities.	2 years ago
src	#22 - Adds complete documentation in Java project files, adds Javadoc for current version dev-0.1.0	2 years ago
.gitignore	#18 - Complete prefab field and rules	2 years ago
BACK_API_ROUTES.md	#22 - Adds complete documentation in Java project files, adds Javadoc for current version dev-0.1.0	2 years ago
Docker-compose.yml	%SPRINT-3% - #11 #12 #13 #14 #15 - Project is reset, first entity added	2 years ago
HELP.md	#18 - Complete prefab field and rules	2 years ago
README.md	#22 - Adds complete documentation in Java project files, adds Javadoc for current version dev-0.1.0	2 years ago
freelyforms-back.postman_collection.json	#22 - Adds complete documentation in Java project files, adds Javadoc for current version dev-0.1.0	2 years ago
mvnw	%SPRINT-3% - #11 #12 #13 #14 #15 - Project is reset, first entity added	2 years ago
mvnw.cmd	%SPRINT-3% - #11 #12 #13 #14 #15 - Project is reset, first entity added	2 years ago
pom.xml	#22 - Adds complete documentation in Java project files, adds Javadoc for current version dev-0.1.0	2 years ago

README.md

Documentation minimale

BACK_API_ROUTES.md - routes disponibles sur l'API
HELP.md - documents d'aide pour Spring Boot
README.md - Instructions d'installation

Les classes et interfaces Java sont documentées ; consultez le code (format Javadoc) ou la documentation générée automatiquement (dossier doc).

Installation - Prod

Requis pour l'installation : Java 17, Spring Boot 2.7, Apache Maven 3.8, Node v18 et npm v8

Installation du package :

mvn clean

mvn package

Exécution du jar résultant :

java -jar target/freelyforms-dev-0.1.0.jar

Le service sera disponible sur localhost:8080. Attention, il s'agit d'un service statique : contrairement au fonctionnement habituel d'une application react/node, la modification du code source n'entraînera pas de modification immédiate de l'application, il vous faudra recompiler (et redéployer le cas échéant).

Ce comportement est établi pour fournir un package de production dont le serveur d'pplication frontend est optimisé et lançable en même temps que l'application backend dans un backage unique.
Consultez le fichier pom.xml pour la description des plugins utilisés pour effectuer cette action.

Exécution - Dev

Il est possible de faire tourner un serveur front (dossier freelyforms-front -> npm run start) en parallèle à un serveur back fonctionnel. Il faut alors s'assurer de lancer aussi le serveur back

Le serveur front de développement (qui lui, pourra changer dynamiquement suivant le contenu des fichiers) sera consultable par localhost:3000 et devrait pouvoir consulter l'API normalement (à tester ! potentiellement à paramétrer pour que le front aille chercher sur le port correspondant au serveur back que ce soit en dev ou en prod !)

Base de données

Pour le développement vous pouvez utiliser une base de données locale ou une base de données partagées Atlas.

Initialisation de la base de données

Consultez la classe Generator (fr.utbm.da50.freelyforms.core.service.Generator) pour créer des fichiers de configuration et des données de formulaire de test à insérer dans la base de donnée.