From 50aac36c94dd349423e5f812b4e777fa0b33e66a Mon Sep 17 00:00:00 2001 From: William Nolin Date: Thu, 4 Mar 2021 19:27:28 -0500 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index ba9cb28..34b4175 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,29 @@ L'application utilise cet API pour vérifier la version de la base de donnée et * `0`: Avant la création de la base de donnée * `1`: Avant l'implémentation d'un API REST * `2`: Après l'implémentation d'un API REST + +## Utilisation autonome +### Prérequis +* Gradle 6.8 ou supérieur +* Java 11 ou supérieur +* Le driver JDBC pour votre système de base de donnée (ex: `mysql-connector-java` pour MySQL) + +### Actions +* Vérifier la version de la base de donnée: `versionCheck` +* Mettre à jour la base de donnée: `update` + +### Étapes +1. Cloner le projet: `git clone https://git.fyloz.dev/color-recipes-explorer/database-manager.git && cd database-manager` +2. Compiler un _shadow jar_: `gradle shadowJar` +3. Naviguer dans le dossier de compilation: `cd build/libs` +4. Créer le fichier de configuration ([exemple](https://git.fyloz.dev/color-recipes-explorer/database-manager/-/blob/master/README.md#exemple-de-fichier-de-configuration)) +5. Exécuter l'utilitaire: `java -cp database-manager-1.0-all.jar:.jar dev.fyloz.colorrecipesexplorer.databasemanager.DatabaseUpdaterKt ` + +## Exemple de fichier de configuration +``` +database.target-version=2 # Voir "Versions de la base de donnée" +database.url=jdbc:mysql://host/ +database.name=database +database.username=user +database.password=pass +```