clavardator/README.md

# Clavardator

This project contains the source for the 4IR Java project.

## Group

* SIMARD Yohan
* VERGNET Arnaud

## Technologies

* Java 11.0.9 (openjdk)
* JavaFX 11.0.2 (openfx)
* Gradle 6.3

## Installation

#### Install Java 11

Run this command
```shell script
sudo apt install openjdk-11-jdk
```

#### Optional: Install JavaFX Scene Builder 11

Follow [this link](https://gluonhq.com/products/scene-builder/) to download and install it, then [this link](https://www.jetbrains.com/help/idea/opening-fxml-files-in-javafx-scene-builder.html) to set up Intellij

#### Build and Run

Run this command

```shell script
./gradlew run
```

Or in Intellij, open the gradle window and click on `clavardator -> Tasks -> application -> run`.

#### Generate cross-platform jar

Run this command

```shell script
./gradlew build
```

This will generate a jar file under `build/libs`.

You can then copy this file and place it on any Linux/Windows/Mac environment with at least Java 11 installed.

You can then run this jar file with this command:

```shell script
java -jar <JAR-NAME>.jar
```

## Resources

* [OpenJDK](https://adoptopenjdk.net/releases.html)
* [JavaFX](https://gluonhq.com/products/javafx/)
* [JavaFX Scene Builder](https://gluonhq.com/products/scene-builder/)
* [Setting up JavaFX](https://openjfx.io/openjfx-docs/)
* [Settings up Scene builder in Intellij](https://www.jetbrains.com/help/idea/opening-fxml-files-in-javafx-scene-builder.html#open-in-scene-builder)
* [Intellij IDEA](https://www.jetbrains.com/idea/)