Ajouter README.md
This commit is contained in:
parent
2325ae5e57
commit
8e1adf5aca
1 changed files with 95 additions and 0 deletions
95
README.md
Normal file
95
README.md
Normal file
|
|
@ -0,0 +1,95 @@
|
||||||
|
# Application PDLA - Gestion des Demandes Bénévoles
|
||||||
|
|
||||||
|
## Prérequis
|
||||||
|
- Java JDK 11 ou supérieur
|
||||||
|
- Apache Maven 3.6 ou supérieur
|
||||||
|
- Eclipse IDE
|
||||||
|
- Accès aux machines INSA (pour l'exécution sur Linux)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### Configuration Eclipse
|
||||||
|
1. Importez le projet dans Eclipse :
|
||||||
|
- File > Import > Maven > Existing Maven Projects
|
||||||
|
- Sélectionnez le dossier racine du projet
|
||||||
|
- Cliquez sur "Finish"
|
||||||
|
|
||||||
|
2. Configuration du build path :
|
||||||
|
- Clic droit sur le projet > Properties
|
||||||
|
- Java Build Path > Libraries
|
||||||
|
- Vérifiez que le JDK est correctement configuré
|
||||||
|
|
||||||
|
### Configuration Maven
|
||||||
|
1. Mettez à jour les dépendances Maven :
|
||||||
|
```bash
|
||||||
|
mvn clean install
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Vérifiez que le fichier `pom.xml` est correctement configuré avec toutes les dépendances nécessaires.
|
||||||
|
|
||||||
|
## Exécution des Tests
|
||||||
|
|
||||||
|
### Dans Eclipse
|
||||||
|
1. Clic droit sur le projet
|
||||||
|
2. Run As > Maven test
|
||||||
|
|
||||||
|
### En ligne de commande (Linux INSA)
|
||||||
|
```bash
|
||||||
|
# Se connecter aux machines INSA
|
||||||
|
ssh votre_login@votre_machine.insa-toulouse.fr
|
||||||
|
|
||||||
|
# Naviguer vers le répertoire du projet
|
||||||
|
cd chemin/vers/votre/projet
|
||||||
|
|
||||||
|
# Exécuter les tests
|
||||||
|
mvn test
|
||||||
|
```
|
||||||
|
|
||||||
|
## Structure du Projet
|
||||||
|
- `src/main/java/` : Code source principal
|
||||||
|
- `controller/` : Contrôleurs de l'application
|
||||||
|
- `database/` : Gestion de la base de données
|
||||||
|
- Classes principales :
|
||||||
|
- BenevoleDemandes*.java
|
||||||
|
- CreateAccountPage.java
|
||||||
|
- LoginPage.java
|
||||||
|
- MenuBenevole.java
|
||||||
|
- SoumettreDemande.java
|
||||||
|
- Validateur.java
|
||||||
|
|
||||||
|
- `src/test/java/` : Tests unitaires et d'intégration
|
||||||
|
- Tests correspondants aux classes principales
|
||||||
|
- Tests de validation
|
||||||
|
- Tests de base de données
|
||||||
|
|
||||||
|
## Exécution de l'Application
|
||||||
|
|
||||||
|
### Dans Eclipse
|
||||||
|
1. Localisez la classe principale
|
||||||
|
2. Clic droit > Run As > Java Application
|
||||||
|
|
||||||
|
### En ligne de commande (Linux INSA)
|
||||||
|
```bash
|
||||||
|
# Compiler et créer le package
|
||||||
|
mvn package
|
||||||
|
|
||||||
|
# Exécuter l'application
|
||||||
|
java -jar target/nom-du-jar.jar
|
||||||
|
```
|
||||||
|
|
||||||
|
## Notes Importantes
|
||||||
|
- Assurez-vous que la base de données est correctement configurée avant l'exécution
|
||||||
|
- Tous les tests doivent passer avant de soumettre des modifications
|
||||||
|
- Utilisez la branche 'master' pour le développement principal
|
||||||
|
|
||||||
|
## Tests
|
||||||
|
L'application inclut plusieurs types de tests :
|
||||||
|
- Tests unitaires pour les composants individuels
|
||||||
|
- Tests d'intégration pour les flux complets
|
||||||
|
- Tests de validation pour les formulaires
|
||||||
|
- Tests de la base de données
|
||||||
|
|
||||||
|
Pour exécuter des tests spécifiques :
|
||||||
|
```bash
|
||||||
|
mvn test -Dtest=NomDuTest
|
||||||
|
```
|
||||||
Loading…
Reference in a new issue