ColorRecipesExplorer
/
Database-Manager
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

This commit is contained in:
William Nolin 2021-03-04 19:27:28 -05:00
parent 63805caf3f
commit 50aac36c94
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -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:<driver>.jar dev.fyloz.colorrecipesexplorer.databasemanager.DatabaseUpdaterKt <action> <configuration>`
## 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
```