ChatApp-AL-NM/README.md

72 lines
2.2 KiB
Markdown

# ChatApp-AL-NM
*Conception et Implementation d'un système de Clavardage. <br>
Collaborateurs : LARTIGUE Auriane (4IR-A1, alartigu@etud.insa-toulouse.fr) et MOUKHLIS Nabil (4IR-A1, moukhlis@etud.insa-toulouse.fr)*
```
git clone https://git.etud.insa-toulouse.fr/alartigu/ChatApp-AL-NM.git
```
## Implémentation
<p>
Contient le code source de notre application de chat.<br>
Nous avons quatre package distincts regroupant nos différentes classes. <br>
<ul>
<li>Controller : Contient la classe "chatApp" qui permet que chaque connexion et chaque session soient entamées. Intermédiaire entre les classes de Model et celles de View.</li>
<li>Model : Contient les classes utilisées/traitées par le contrôleur, dont la base de données.</li>
<li>Protocol : Contient les classes permettant les communications en UDP et TCP. </li>
<li>View : Contient les classes constituant l'interface graphique.</li>
</ul>
</p>
## Application
<p>
<ul>
<li> L'application de chat sous format .JAR : 'chatapp-1.0-SNAPSHOT-all.jar' </li>
<li> Un fichier de configuration : 'config.json' </li>
</ul>
</p>
## Javadoc
<p>
Des commentaires étant présents dans le code source de notre application, nous avons généré la documentation dans ce dossier.
</p>
## Rapport
<p>
Dossier comprenant deux rapports :
<ul>
<li> Le rapport de la conception avec des explications des différents diagrammes.</li>
<li> Le rapport de l'implémentation avec des explications sur le code et l'utilisation de l'application.</li>
</ul>
</p>
#### Conception
<p>
Ce dossier contient les différents diagrammes en format "png". <br>
<ul>
<li>Diagramme de cas d'utilisation</li>
<li>Diagramme de classe (MVC)</li>
<li>Diagramme de séquence </li>
<li>Diagramme de Structure Composite</li>
<li>Diagramme de Machine à Etats</li>
</ul>
</p>
## Serveur
<p>
Le code source du serveur de présence, celui-ci faisant office de proxy. <br>
Un fichier WAR utilisée pour déployer le serveur de présence.
</p>
## Techologies Utilisées
<p>
<ul>
<li>JAVAFX 11.0.2</li>
<li>JAVA 13</li>
<li>GRADLE</li>
<li>MySQL Connector 8.0.22 </li>
</ul>
</p>