Merge Doc/dev

README.md

@@ -1,7 +1,144 @@
-# SAE-5
+# :mortar_board: NetWorkers
 
-B3S1 Project
+> SAé5-1  
 
-## Front Readme
+## :memo: • Description
 
-[Cliquez ici pour accéder au README du Front](./front-js/README.md)
+NetWorkers est un projet de 3ème année de l'IUT de Vélizy.  
+Il consiste en une application pour apprendre des notions sur les réseaux informatiques.  
+
+## :rocket: • Pour commencer
+
+### :package: • Pré-requis
+
+- [Python2.5 (et plus)](https://www.python.org/downloads/release/python-250/)
+- [Docker](https://docs.docker.com/get-docker/)
+
+### :inbox_tray: • Installation et configuration
+
+**Si Git n'est pas istaller :**  
+
+```bash
+sudo apt-get update
+sudo apt-get install git
+```
+
+**Si Docker et Python ne sont pas installer :**  
+
+```bash
+sudo apt-get update
+sudo apt-get install python
+
+# Add Docker's official GPG key:
+sudo apt-get update
+sudo apt-get install ca-certificates curl
+sudo install -m 0755 -d /etc/apt/keyrings
+sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
+sudo chmod a+r /etc/apt/keyrings/docker.asc
+
+# Add the repository to Apt sources:
+echo \
+  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
+  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
+  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+sudo apt-get update
+
+sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
+```
+
+:warning: Il faut installer Git avant Docker afin d'éviter des problèmes lors du clone.  
+
+1. Cloner la dernière version du projet ([releases](https://www.github.com/444chak/SAE-5/releases)).
+
+```bash
+REPO_URL="https://github.com/444chak/SAE-5.git"
+LAST_TAG=$(git ls-remote --tags --sort="v:refname" $REPO_URL | tail -n 1 | awk '{print $2}' | sed 's/refs\/tags\///')
+git clone --branch $LAST_TAG --single-branch $REPO_URL
+cd SAE-5
+```
+
+> *Ce script vous permet de récupérer le code du dernier tag présent sur le projet.*  
+
+2. Lancer le script pour mettre en place les variables d'environnement.
+
+```bash
+python set_env.py
+```
+
+3. Ajouter son utilisateur au groupe Docker.  
+
+```bash
+sudo usermod -aG docker <user>
+```
+
+### :rocket: • Démarrage
+
+```bash
+docker compose up
+```
+
+## :clipboard: • Documentation technique
+
+- [#API](api/README.md)  
+- [#Client](front-js/README.md)  
+
+## :gear: • Technologies utilisées
+
+- :snake: [Python](https://www.python.org/)  
+- :satellite: [FastAPI](https://fastapi.tiangolo.com/)  
+- :lipstick: [Next.js](https://nextjs.org/)  
+- :whale: [Docker](https://www.docker.com/)  
+- :floppy_disk: [MariaDB](https://mariadb.org/)  
+
+## :wrench: • Maintenance
+
+Pour maintenir ce projet, il est nécessaire de prendre connaissance des différentes documentations techniques ([#Documentation technique](#clipboard--documentation-technique)).  
+
+Pour voir l'état des différents composants de l'application, vous pouvez exécuter la commande suivante :  
+
+```bash
+docker compose ps
+```
+
+Si vous devez accéder aux différents composants de l'applications, vous pouvez exécutez les commandes suivantes :  
+
+Accéder à l'API :  
+
+```bash
+docker exec -it networkers-api bash
+```
+
+Accéder au client :  
+
+```bash
+docker exec -it networkers-web bash
+```
+
+Accéder à la base de données :  
+
+```bash
+docker exec -it networkers-db bash
+
+mariadb -p
+# Entrez le mot de passe que vous aviez défini dans le script set_env.py
+```
+
+Si vous avez besoin de redémarrer un composant de l'application, vous pouvez exécuter la commande suivante :  
+
+```bash
+docker compose restart <component>
+```
+
+Si vous devez arrêter l'application, vous pouvez exécuter la commande suivante :  
+
+```bash
+docker compose down
+```
+
+## :busts_in_silhouette: • Auteurs
+
+- [**@Eliott BARKER**](https://wwww.github.com/Eliott-B)  
+- [**@Maxence OUVRARD**](https://github.com/MaxOuvrard)  
+- [**@Chakib OUALI**](https://github.com/444chak)  
+- [**@Ilan RUBIO**](https://github.com/IlanRubio)  
+- [**@Kylian GRAVIER**](https://github.com/SaAxok)