2024-DEV-BUT3/README.md
2024-05-13 01:42:15 +02:00

67 lines
2.4 KiB
Markdown

# Projet BUT 3
made by :
Simon CATANESE
Julien CHARBONNEL
Victor DESCAMPS
## Tests warning :
the tests sheet 'api/image-request.test.jsx' was commented out to avoid over-sending requests to the google API during development. Remember to uncomment the file if you want to run all the tests once, but remember to recomment the file if you want to run a series of tests.
An over-sending of requests could get us blocked for the day by google.
## Project summary (FR):
Nous n'avons pas réussi à mettre en œuvre toutes les fonctionnalités de l'interface utilisateur à temps. Le développement n'a pas non plus été rigoureusement test-driven.
résumé des fonctionnalités :
En se connectant, l'utilisateur peut charger la liste des articleset les filtrer par pièce, date, nom, etc. Il est possible de créer et de mettre à jour des articles.
(Il n'y a pas de confirmation de réussite ou d'échec de création/update. La page doit être actualisée pour voir les résultats.)
Une page permet de consulter les statistiques des pièces et la liste des pièces. Il est possible d'y créer de nouvelles. La mise à jour des piècesn'est pas encore implémentée.
Les icones AntDesign provoquent systématiquement une exception dans la console. Nous n'avons pas été en mesure de corriger ou éviter cette erreur. Les icones s'affichent bien, donc ça ne posera pas de problème à part la pollution de la console.
Nous avons voulu personnaliser un peu notre projet pour le différencier des autres, nous avons donc mis en place un système simple de recherche automatique d'images liées aux objets enregistrés, et une requête à l'API Inspirobot à chaque rechargement de la page sur la page d'accueil pour un accueil chaleureux.
Nous sommes conscients que ce projet ne correspond pas exactement aux attentes d'un développement full test-driven. Mais nous nous satisfaisons tout de même de nous être familiarisés avec js et React, avec les tests en général, et d'avoir pris du plaisir à développer ce petit projet.
Nous vous souhaitons une bonne correction et vous remercions pour vos cours.
Traduit avec DeepL.com (version gratuite)
## Run Locally
Clone the project
```bash
git clone gitea@dwarves.iut-fbleau.fr:legrelle/Projet-dev-but3-2024.git
```
Go to the project directory
```bash
cd Projet-dev-but3-2024
```
Install dependencies
```bash
npm i
```
Start the front-end
```bash
npm run dev
```
## API Reference
API Documentation : [Postman]([Postman documentation url])