refacto - ReadMe.md and README_EN.md.md

README.md

@@ -1,4 +1,10 @@
-# Projet Développent Web - 2024
+# Cards Rush - Projet Développement Web - 2024
+
+English version available [here](README_EN.md)
+
+## Auteurs :
+- [Kevin MITRESSÉ](http://kmitresse.free.fr)
+- [Lucàs VABRE](https://portfolio-lucasvbr.vercel.app/)
 
 ## Installation
 
@@ -36,14 +42,15 @@ Depuis un terminal bash (ou git bash), se positionner à la racine du projet pui
 # Lancement du container docker contenant la base de données
 # project_devweb est le nom du projet, vous pouvez le changer à votre guise
 # retirer la commande -p project_devweb si vous ne souhaitez pas nommer le projet, il portera par défaut le nom du dossier contenant le projet
-docker-compose -p project_devweb up -d
+docker-compose -p cardsRush up -d
 
 # Installation des dépendances maven
+mvn clean package
 mvn install
 ````
 
 ## Lancement du projet
-Depuis IntelliJ, ouvrir l'onglet `file > project structure` et ajouter les artefacts suivants :
+Depuis IntelliJ, ouvrir l'onglet `file > project structure` et vérifier que les artefacts suivants sont bien présents :
 - project: war
 - project: war exploded
 
@@ -55,3 +62,19 @@ Sur IntelliJ, vous pouvez ajouter une configuration Tomcat depuis l'onglet "edit
 
 Editez la configuration comme suit (le port utilisé pour Tomcat conseillé est 8080, mais vous pouvez le changer si vous le souhaitez ou s'il est déjà utilisé par un autre service sur votre machine) :
 ![Configuration Tomcat.png](readmeTools/tomcat_configuration.png)
+![Configuration Tomcat2.png](readmeTools/tomcat_deployment.png)
+
+Enfin, allumez votre container docker contenant la base de données puis lancez l'application depuis votre navigateur.
+
+## Parties multijoueurs
+
+Cards Rush est un jeu multijoueurs. Pour joueur avec vos amis en local, vous devez être connecté au même réseau (même wifi, même partage de connexion, etc...).
+
+Le lien a utiliser pour accéder au jeu est le suivant : `http://ip:8080/cardsrush_war_exploded/` (ip étant l'adresse ip de la machine hébergeant le serveur Tomcat).
+
+L'application n'étant pas encore hébérgée en ligne, il est nécessaire de lancer l'application sur une machine et de partager l'adresse ip de cette machine pour que les autres joueurs puissent se connecter.
+
+## Potentielles améliorations à prévoir:
+
+- Hebergement du jeu en ligne.
+- Ajout d'un chat pour les parties multijoueurs lorsque l'application sera hébergée en ligne.

README_EN.md

@@ -0,0 +1,91 @@
+# Cards Rush - Web Development Project - 2024
+
+Version française disponible [ici](README.md)
+
+## Authors :
+
+- [Kevin MITRESSÉ](http://kmitresse.free.fr)
+- [Lucàs VABRE](https://portfolio-lucasvbr.vercel.app/)
+
+## Installation
+
+To be able to run the project, you need to have docker and maven installed on your machine.
+
+### Installation of docker desktop
+
+To install docker desktop, go to the official docker website and download the version corresponding to your operating system.
+
+Link: [Docker Desktop](https://www.docker.com/products/docker-desktop)
+
+### Installation of maven
+
+To install maven, go to the official maven website and download the version corresponding to your operating system.
+
+Link to an installation tutorial: [Maven](https://www.baeldung.com/install-maven-on-windows-linux-mac)
+
+### Additional prerequisites (only for windows)
+
+On windows, you need to have installed a bash terminal system like git bash or windows terminal.
+
+`Recommended` Link to git bash (Easy to use and groups all bash commands): [Git Bash](https://git-scm.com/downloads)
+
+Link to windows terminal: [Windows Terminal](https://www.microsoft.com/fr-fr/p/windows-terminal/9n0dx20hk701?activetab=pivot:overviewtab)
+
+### Project installation
+
+Once all the tools are installed.
+Run the following commands to install the project:
+
+From a bash terminal (or git bash), go to the root of the project and run the following commands:
+
+```` bash
+
+# Create the .sql scripts
+./mysql/build.sh
+
+# Launch the docker container containing the database
+# project_devweb is the name of the project, you can change it as you wish
+# remove the -p project_devweb command if you do not want to name the project, it will default to the name of the folder containing the project
+docker-compose -p cardsRush up -d
+
+# Install maven dependencies
+mvn clean package
+mvn install
+````
+## Launch of the project
+
+From IntelliJ, open the `file > project structure` tab and check that the following artifacts are present:
+- project: war
+- project: war exploded
+
+![Onglet project_structure.png](readmeTools/project_structure.png)
+
+We use tomcat to launch our project.
+
+On IntelliJ, you can add a Tomcat configuration from the "edit run configurations" tab, then by clicking on the "+" button at the top left of the launch window.
+
+Edit the configuration as follows (the port used for Tomcat is 8080, but you can change it if you wish or if it is already used by another service on your machine):
+![Configuration Tomcat.png](readmeTools/tomcat_configuration.png)
+![Configuration Tomcat2.png](readmeTools/tomcat_deployment.png)
+
+Finally, start your docker container containing the database and launch the application from your browser.
+
+## Multiplayer games
+
+Cards Rush is a multiplayer game. To play with your friends locally, you must be connected to the same network (same wifi, same connection sharing, etc...).
+
+The link to use to access the game is as follows: `http://ip:8080/cardsrush_war_exploded/` (ip being the ip address of the machine hosting the Tomcat server).
+
+As the application is not yet hosted online, it is necessary to launch the application on a machine and share the ip address of this machine so that other players can connect.
+
+
+## Potential improvements to consider:
+
+- Hosting the game online.
+- Adding a chat for multiplayer games when the application is hosted online.
+
+
+## Potentielles améliorations à prévoir:
+
+- Hebergement du jeu en ligne.
+- Ajout d'un chat pour les parties multijoueurs lorsque l'application sera hébergée en ligne.