Skip to content

Commit

Permalink
adding badge
Browse files Browse the repository at this point in the history
  • Loading branch information
Elyas ELAZIZ committed May 4, 2024
1 parent 9aa9c0a commit 14e07a4
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 21 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/gradle.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
run: ./gradlew build

- name : Run tests
run : ./gradlew test
run : ./gradlew cleanTest test

# NOTE: The Gradle Wrapper is the default and recommended way to run Gradle (https://docs.gradle.org/current/userguide/gradle_wrapper.html).
# If your project does not have the Gradle Wrapper configured, you can use the following configuration to run Gradle with a specified version.
Expand Down
23 changes: 3 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
![Java CI with Gradle](https://github.com/baldraven/Flashcards/actions/workflows/gradle.yml/badge.svg)

# Coding Week 2023 - Telecom Nancy Flashcards

## Description
Expand All @@ -17,28 +19,9 @@ Il suffit d'exécuter le .jar disponible à la racine du projet, avec par exempl
## Utilisation

Merci de consulter la vidéo explicative ci-dessous !

lien : https://www.youtube.com/watch?v=RoNNlyUJxgQ

## Compilation

Configuration Gradle inspirée du projet MOCI DP de M. Charoy :

"Ce projet est auto-suffisant dans le sans où il propose d'utiliser l'outil Gradle (https://gradle.org/) pour construire l'application fournie.
Un simple `./gradlew run` dans un terminal devrait vous télécharger l'outil gradle, télécharger les dépendances nécessaires (JavaFX en autre), lancer la compilation et exécuter le programme.

Il se peut que vous rencontriez des problèmes. Voici quelques solutions :
- il faut que le script `./gradlew` soit exécutable (un simple `chmod a+x ./gradlew` devrait faire l'affaire)
- Gradle ne supportant pas encore Java 19, il faut utiliser une version 17 ou 18 du Java Development Kit (JDK) (utiliser la commande `java --version` ou un `./gradlew --version` pour vérifier votre version actuelle du JDK.)

Cette configuration peut également être importer dans IntelliJ pour créer un projet fonctionnelle à partir de celle-ci. Pour cela, lors de la création de votre projet IntelliJ, il faut sélectionner le fichier `build.gradle` et non pas uniquement le répertoire du projet."

## Tests

Pour lancer les tests dans le dossier test/, lancer la commande `./gradlew cleanTest test` (méthode inspirée de celle des TP java de M. Oster).

Il a été tenté d'intégrer la librairie TestFX pour les tests, mais cela a mené à des problemes d'intégration avec gradle et de dépendances. Cela a donc été abandonné (malgré les heures passées dessus !), et les tests sur l'interface graphique sont effectués manuellement.

## Remerciements

Merci à notre cliente pour ses retours et aux contributeurs du projet pour leur dévouement durant 4 jours.
Pour lancer les tests dans le dossier test/, lancer la commande `./gradlew cleanTest test` (méthode inspirée de celle des TP java de M. Oster).

0 comments on commit 14e07a4

Please sign in to comment.