GLO-2003 - Équipe 03 === ## Guide de démarrage ### Prérequis Logiciels nécessaires au bon fonctionnement de l'application: - Java >= 8 - Maven ### Lancement de l'application Si c'est la première que vous lancez l'application, il vous faut installer les dépendances à l'aide de Maven: ```bash $ mvn clean install ``` ## Commandes utiles Une fois les dépendances installées, vous pouvez lancer l'application qui sera desservie à l'adresse suivante: http://localhost:4567 ```bash $ mvn exec:java ``` Il est possible d'exécuter tous les tests unitaires du projet avec la commande suivante: ```bash $ mvn test ``` Il est également possible d'obtenir un rapport de couverture de code pour ces tests. Une fois générer, celui-ci sera disponible sous `target/site/jacoco/index.html`. ```bash $ mvn jacoco:report ``` Un linter est aussi mis à la disposition des utilisateurs pour s'assurer de respecter le style de programmation choisi par l'équipe (Google Java). Un pre-commit hook sera également installer lors de la première installation du projet. ```bash $ mvn git-code-format:format-code -DglobPattern=**/* ``` ## Utilisation de l'application L'application est une API Web, vous pouvez donc tester son bon fonctionnement en vous rendant à l'adresse http://localhost:4567/hello qui retournera `Hello World` en format JSON. ## Hébergement Le site est en ligne à l'adresse suivante: https://glo2003-h2020-eq03.herokuapp.com ## Membre de l'équipe - [Alexandre de Beaumont](https://github.com/Ocaenyth) - [Pierre-Yves Caron-Ouellette](https://github.com/Flitnet) - [Maxime Corriveau-Faucher](https://github.com/Ender0Storm) - [Nicolas Dionne](https://github.com/NicolasDionne) - [Xavier Filion](https://github.com/Brutalysk) - [Vincent Grégoire](https://github.com/zeasdfgt) - [Samuel Murret-Labarthe](https://github.com/xsam00) - [Jonathan Samson](https://github.com/ZeCaype)