2024-DEV-BUT3/README.md

67 lines
2.4 KiB
Markdown
Raw Normal View History

2024-03-27 10:51:41 +01:00
# 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.
2024-05-13 01:42:15 +02:00
## Project summary (FR):
Nous n'avons pas r<>ussi <20> mettre en <20>uvre toutes les fonctionnalit<69>s de l'interface utilisateur <20> temps. Le d<>veloppement n'a pas non plus <20>t<EFBFBD> rigoureusement test-driven.
r<EFBFBD>sum<EFBFBD> des fonctionnalit<69>s :
En se connectant, l'utilisateur peut charger la liste des articleset les filtrer par pi<70>ce, date, nom, etc. Il est possible de cr<63>er et de mettre <20> jour des articles.
(Il n'y a pas de confirmation de r<>ussite ou d'<27>chec de cr<63>ation/update. La page doit <20>tre actualis<69>e pour voir les r<>sultats.)
Une page permet de consulter les statistiques des pi<70>ces et la liste des pi<70>ces. Il est possible d'y cr<63>er de nouvelles. La mise <20> jour des pi<70>cesn'est pas encore impl<70>ment<6E>e.
Les icones AntDesign provoquent syst<73>matiquement une exception dans la console. Nous n'avons pas <20>t<EFBFBD> en mesure de corriger ou <20>viter cette erreur. Les icones s'affichent bien, donc <20>a ne posera pas de probl<62>me <20> part la pollution de la console.
Nous avons voulu personnaliser un peu notre projet pour le diff<66>rencier des autres, nous avons donc mis en place un syst<73>me simple de recherche automatique d'images li<6C>es aux objets enregistr<74>s, et une requ<71>te <20> l'API Inspirobot <20> 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 <20>tre familiaris<69>s avec js et React, avec les tests en g<>n<EFBFBD>ral, et d'avoir pris du plaisir <20> d<>velopper ce petit projet.
Nous vous souhaitons une bonne correction et vous remercions pour vos cours.
Traduit avec DeepL.com (version gratuite)
2024-03-27 10:51:41 +01:00
## 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])