Skip to content
Snippets Groups Projects
Commit f7cfa865 authored by BEAUVAIS ANTOINE's avatar BEAUVAIS ANTOINE
Browse files

Merge branch 'doc-update' into 'master'

Updated README documents.

See merge request !29
parents e8001e43 7e589463
Branches
2 merge requests!30Master to develop,!29Updated README documents.
......@@ -47,29 +47,19 @@ Il est conseillé d'utiliser un IDE Java pour exécuter et déployer l'applicati
Assurez-vous que votre machine possède un kit de développement Java (JDK) version
**8 ou ultérieur**. Le JDK complet est requis pour compiler l'application. Le fichier WAR
peut être déployé sur une machine ne possédant que la JRE.
Afin que l'application fonctionne, vous devez configurer une clé d'authentification
pour l'API REST.
Dans `src/main/resources`, créez un nouveau fichier `apikey.properties` contenant :
```
api.key=MyApiKey
```
#### Compilation et exécution
Vous pouvez compiler et lancer le projet en utilisant la commande suivante sur
un système UNIX ou UNIX-like :
```
./gradlew bootRun
./gradlew bootRun --args="--spring.profiles.active=dev"
```
Sur Microsoft Windows, utilisez :
```
.\gradlew bootRun
.\gradlew bootRun --args="--spring.profiles.active=dev"
```
Quand l'application tourne, vous pouvez y accéder à travers l'adresse URL
......
......@@ -48,26 +48,18 @@ Make sure you have a Java Development Kit version **8 or later** installed on yo
You must have the full JDK to build the program. You can deploy the WAR file on a machine
with the JRE only.
First, make sure you create an API key for the application.
In `src/main/resources`, create a new `apikey.properties` file that contains:
```
api.key=MyApiKey
```
#### Building and running
You can build and run the project using the following command on UNIX-based systems:
```
./gradlew bootRun
./gradlew bootRun --args="--spring.profiles.active=dev"
```
On Microsoft Windows, use:
```
.\gradlew bootRun
.\gradlew bootRun --args="--spring.profiles.active=dev"
```
When running, you can reach the application at [http://127.0.0.1:8080/](http://127.0.0.1:8080/).
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment