Merge branch 'main' into develop

.drone.yml

@@ -29,7 +29,7 @@ steps:
 - name: pull
   image: appleboy/drone-ssh
   settings:
-    host: flash.princelle.org
+    host: cloud.princelle.org
     username: mprincelle
     port: 22
     key:
@@ -43,7 +43,7 @@ steps:
 - name: configure
   image: appleboy/drone-ssh
   settings:
-    host: flash.princelle.org
+    host: cloud.princelle.org
     username: mprincelle
     port: 22
     key:
@@ -59,7 +59,7 @@ steps:
 - name: build
   image: appleboy/drone-ssh
   settings:
-    host: flash.princelle.org
+    host: cloud.princelle.org
     username: mprincelle
     port: 22
     key:

README.md

-Projet ERP RMS <img src="./public/logo.png" width="60" height="90" />
-==============
+<div align="center">
+<div>
+  <img src="https://git.unistra.fr/erp-sil/rms/-/raw/main/public/logo.png" alt="AIUS Logo" height="200px" />
+  <img src="https://git.unistra.fr/uploads/-/system/project/avatar/21819/cashier2_117800.png" alt="RMS Logo" width="200px" height="200px" />
+</div>
+
+# Projet ERP : Module RMS
+
+</div>
 
 [![Build Status](https://drone.princelle.org/api/badges/erp-sil/rms/status.svg?ref=refs/heads/main)](https://drone.princelle.org/erp-sil/rms)
 
 Ce projet est une interface, mise a disposition pour l'administration de l'[AIUS](https://fr-fr.facebook.com/aius.strasbourg/). Elle materialise une caisse enregistreuse dématerialisée permetant la gestion des achat et du stock.
 
+Le code de cette application est accessible à l'adresse suivante : https://git.unistra.fr/erp-sil/rms.
+
 L'application est disponible via l'URL : https://rms.erp.uni.princelle.org
 
 **Informations de connexion :**
@@ -14,58 +23,86 @@ L'application est disponible via l'URL : https://rms.erp.uni.princelle.org
 
 **Membres du groupe :**
 
-* BRUA Hugo
-* LAFORÊT Nicolas
-* PRINCELLE Maxime
-* VAUCHAIR Marline
+- BRUA Hugo
+- LAFORÊT Nicolas
+- PRINCELLE Maxime
+- VAUCHAIR Marline
 
-### Table des matières
-1. [Installation du module](#module-installation)
-2. [Dépendences](#dependencies)
-6. [Configuration](#configuration)
-7. [Fonctionnalité](#module-operating)
+## Table des matières
 
-### Installation du module <a name="module-installation"></a>
+1. [Installation du module](#installation-du-module)
+2. [Dépendances](#dépendances)
+3. [Configuration](#configuration)
+4. [Fonctionnalités](#fonctionnalités)
 
-Dans le dossier \RMS, vous pouvez lancer la commande :
-#### `docker-compose up`
+## Installation du module
 
+Ce projet nécessite la présence de **Docker** et **Docker Compose** sur votre système :
 
-### Dépendences <a name="dependencies"></a>
+- Pour installer Docker, consultez la [documentation officielle](https://docs.docker.com/get-docker/).
+- Pour installer Docker Compose, suivez les [instructions suivantes](https://docs.docker.com/compose/install/).
 
-Ce projet est crée avec [Create React App](https://fr.reactjs.org/) et [Tailwind](https://tailwindcss.com/).
+Une fois le projet téléchargé, vous pouvez dans le dossier racine, lancer la commande suivante :
 
-### Confirguration <a name="configuration"></a>
+```bash
+docker-compose up -d
+```
 
-Rajoutez un fichier `.env` à la racine du dossier \RMS, suivant ce model:
+## Dépendances
 
+Ce projet a été créé avec :
+
+- [React](https://fr.reactjs.org/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Tailwind](https://tailwindcss.com/)
+
+## Configuration
+
+Rajoutez un fichier `.env` à la racine du projet RMS, en suivant ce modèle:
+
+```env
+REACT_APP_BACK_URL="back.erp.uni.princelle.org"
+REACT_APP_MONEY_URL="money.erp.uni.princelle.org"
+REACT_APP_STUDENT_URL="student.erp.uni.princelle.org"
+REACT_APP_BACK_API_KEY="theapikey"
+APP_PORT=8080
 ```
-REACT_APP_BACK_URL=""
-REACT_APP_MONEY_URL=""
-REACT_APP_STUDENT_URL=""
-REACT_APP_BACK_API_KEY=""
-APP_PORT=
-```
 
-### Fonctionnalité <a name="module-operating"></a>
+Vous pourrez ensuite accéder à l'application via l'URL locale : http://localhost:8080
+
+**Informations de connexion :**
+
+- Nom d'utilisateur/email : test@test.com
+- Mot de passe : test1234
+
+## Fonctionnalités
+
+Cette application se décompose en trois espaces :
+
+### Vente
+
+L'espace Vente affiche la liste des produits disponibles.
+
+Il permet de mettre des articles dans le panier et de payer.
+
+Il affiche également l'état des stocks.
 
-Cette application se décompose en trois espaces:
 
-#### Vente
+> Écran 'Vendre' :
+![Écran 'Vendre'](./screenshots/vendre.png)
 
-L'espace vente affiche la liste des produits disponibles.
-Il permet la mise en pannier de produits et de les facturer.
 
-<img src="./public/vente.png" width="750" height="300" />
+> Écran 'Panier' :
+![Écran 'Panier'](./screenshots/panier.png)
 
-#### Gestion des stocks
+### Gestion des stocks
 
-L'espace de Gestion des stocks permet de redéfinir la quantitité disponible de chaque produit.
+L'espace de 'Gestion des stocks' permet de redéfinir la quantité disponible de chaque produit.
 
-<img src="./public/stock.png" width="750" height="300" />
+> ![Écran 'Gestion des stocks'](./screenshots/stocks.png)
 
-#### Utilisateurs
+### Utilisateurs
 
-L'espace Utilisateur affiche la liste des utilisateurs en affichant leurs caractéristiques notament s'ils sont adhérant.
+L'espace 'Utilisateur' affiche la liste des utilisateurs avec leurs informations y compris leur statut adhérant.
 
-<img src="./public/utilisateurs.png" width="750" height="200" />
\ No newline at end of file
+> ![Écran 'Utilisateurs'](./screenshots/utilisateurs.png)
\ No newline at end of file