public/Telereview
1
0
Fork 0
mirror of https://git.roussel.pro/telecom-paris/pact.git synced 2026-02-09 10:30:17 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Début test interface borne

Browse Source
This commit is contained in:
Quentin Roussel
2023-01-04 22:07:32 +01:00
parent 66d1aaf027
commit b31ee7c0b9
39 changed files with 3354 additions and 3260 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
code/server/README.md
View File

@@ -1,31 +1,31 @@
# Installation
* Pour faire fonctinoner le serveur sur vos machines il y a 3 choses a faire
1. Installer node js : https://nodejs.org/en/download/
2. Ouvrir un terminal et aller dans ce dossier (code/server) et tapper `npm install` pour installer les pacakges nécessaires
3. copier le fichier `.env_template` et le nommer `.env` et remplir les variables (cela est fait pour le pas mettre les mots de passes sur le gitlab, faites attention de ne jamais commit le fichier .env !!)
4. pour lancer le serveur faire `node index.js`
# Utilisation
## Avis laissés sur la borne (hors réseaux sociaux)
### Routes GET :
- `/borne/get_last_reviews?limit=LIM` : renvoie les LIM derniers avis sur la borne
- `/borne/get_review?id=ID` : renvoie les infos sur l'avis d'in ID
- `/borne/get_criteres` : renvoie les criteres de notations valide pour les notes autres
- `/borne/notes_autres?critere=CRIT&limit=LIM` : renvoie les LIM dernières notes sur le critère CRIT
- `/borne/notes_autres?id=ID&limit=LIM` : renvoie toutes les notes spécifiques liées à l'avis ID
### Routes POST
- `/add_review` : Ajoute une review et un auteur, paramètres POST :
* [OBLIGATOIRE] `note` : note principale de la review entre 0 et 10 compris
* [OBLIGATOIRE] `source` : nom de la source de l'avis, doit être `borne` ou `website` pour resp la borne et le site
* `auteur_age` : age de l'auteur
* `auteur_sexe` : sexe de l'auteur (valeurs valide 'f', 'h', 'a')
* `commentaire` : Commentaire laissé avec l'avis
* `notes autres` : sous la forme
```json
{
"critere1": 8,
"critere2": 2,
"critere3": 0
}
```
# Installation
* Pour faire fonctinoner le serveur sur vos machines il y a 3 choses a faire
1. Installer node js : https://nodejs.org/en/download/
2. Ouvrir un terminal et aller dans ce dossier (code/server) et tapper `npm install` pour installer les pacakges nécessaires
3. copier le fichier `.env_template` et le nommer `.env` et remplir les variables (cela est fait pour le pas mettre les mots de passes sur le gitlab, faites attention de ne jamais commit le fichier .env !!)
4. pour lancer le serveur faire `node index.js`
# Utilisation
## Avis laissés sur la borne (hors réseaux sociaux)
### Routes GET :
- `/borne/get_last_reviews?limit=LIM` : renvoie les LIM derniers avis sur la borne
- `/borne/get_review?id=ID` : renvoie les infos sur l'avis d'in ID
- `/borne/get_criteres` : renvoie les criteres de notations valide pour les notes autres
- `/borne/notes_autres?critere=CRIT&limit=LIM` : renvoie les LIM dernières notes sur le critère CRIT
- `/borne/notes_autres?id=ID&limit=LIM` : renvoie toutes les notes spécifiques liées à l'avis ID
### Routes POST
- `/add_review` : Ajoute une review et un auteur, paramètres POST :
* [OBLIGATOIRE] `note` : note principale de la review entre 0 et 10 compris
* [OBLIGATOIRE] `source` : nom de la source de l'avis, doit être `borne` ou `website` pour resp la borne et le site
* `auteur_age` : age de l'auteur
* `auteur_sexe` : sexe de l'auteur (valeurs valide 'f', 'h', 'a')
* `commentaire` : Commentaire laissé avec l'avis
* `notes autres` : sous la forme
```json
{
"critere1": 8,
"critere2": 2,
"critere3": 0
}
```