Commit 1b4d8a53 authored by Seyller Vincent's avatar Seyller Vincent 🙂
Browse files

Update README.md

parent 597e73bf
# ShareLoc-React
# ShareLoc-React - SEYLLER Vincent / LAVIGNE Céleste
Partie application web du projet ShareLoc.
## Introduction et concept
Pour comprendre le projet, voici à peu près comment nous avons séparé les choses au sein des applications et de l'api :
Il y a 8 classes distinctes :
- User
- Colocation
- Membre (un utilisateur dans une colocation)
- Service
- AchievedService (service en cours de validation, ou terminé)
- RequestedService (service nécessitant des votes, et pourquoi (suppression, validation ?))
- Vote (un vote pour un RequestedService)
- Message (un message d'un utilisateur)
## Application web
Voici les différents fichiers de l'application :
| Fichier | Description | Permet d'accéder à |
| ------ | ------ | ------ |
| [ShareLoc.js](/src/ShareLoc.js) | Génère la page d'accueil ainsi que l'ensemble des routes pour l'application. C'est le fichier "parent" | [Signin.js](/src/Signin.js), [Signup.js](/src/Signup.js), [Colocation.js](/src/Colocation.js), [Edit.js](/src/Edit.js) |
| [Signin.js](/src/Signin.js) | Permet à l'utilisateur de créer un compte | [Signup.js](/src/Signup.js) |
| [Signup.js](/src/Signin.js) | Permet à l'utilisateur de se connecter | [Colocation.js](/src/Colocation.js) |
| [Edit.js](/src/Edit.js) | Permet à l'utilisateur de modifier son compte | [ShareLoc.js](/src/ShareLoc.js) |
| [Colocation.js](/src/Colocation.js) | Montre toutes les colocations de l'utilisateur, et permet d'en créer | [Details.js](/src/ShareLoc.js) |
| [Details.js](/src/Details.js) | Permet à l'utilisateur de voir les membres d'une colocation et d'ajouter un service (ou un membre s'il est administrateur) | [AchievedServices.js](/src/AchievedServices.js), [RequestedServices.js](/src/RequestedServices.js), [Services.js](/src/Services.js), [Messages.js](/src/Messages.js) |
| [AchievedServices.js](/src/AchievedServices.js) | Permet à l'utilisateur de voir tous les services terminés (ne marche pas complètement*)| |
| [RequestedServices.js](/src/RequestedServices.js) | Permet à l'utilisateur de voir tous les services qui ont besoin de son vote (ne marche pas**) | |
| [Services.js](/src/Services.js) | Permet à l'utilisateur de voir tous les services non terminés de la colocation | |
| [Messages.js](/src/Messages.js) | Permet à l'utilisateur de voir les messages de la colocation et d'en envoyer | |
*N'affiche pas les bénéficiaires du service.
**Initialement, le vote devait se faire sur cette page. Je n'ai donc pas pu implémenter les votes dans l'application web.
En raison d'un problème commun, ces pages n'ont pas réussies à être réglées dans les temps (erreurs de requêtes dans les appels de l'API dans les sous-composants des classes, comme par exemple pour chaque AchievedService, récupérer les bénéficiaires).
Voici donc le résumé des fonctionnalités implémentées et non implémentées :
- [x] Inscription
- [x] Connexion
- [x] Modification de profil
- [x] Liste des colocations (possédées ou non)
- [x] Création d'une colocation
- [x] Invitation d'un nouveau membre
- [x] Liste des membres
- [x] État actuel des points par membre
- [x] Liste des services
- [x] Proposer un nouveau service
- [ ] Vote pour l'ajout d'un nouveau service
- [x] Historiques des services faits
- [ ] Déclarer un service fait
- [ ] Vote pour la validation d'une déclaration
- [x] Historique des messages
- [x] Envoyer de nouveaux messages
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment