Nantes Université - IUT - BUT Informatique

eq_02_03

SAE de Semestre 4 (2ème semestre de BUT2)

Sommaire

1. Présentation
   • Description
   • Membres du groupe
   • Les liens du projet
2. Avertissements
3. Structure du projet
   • API externes au projet
   • API internes au projet
   • Autres
4. Infrastructure du projet
5. Les commandes
   • Lancer le projet
   • Générer les docs
   • Autres commandes
   • Vider la base de données
   • Peupler la base de données
6. Crédits

Présentation

Description

Dans le cadre de la SAE du Semestre 4 (2ème semestre de BUT2) nous devions créer un site Web utilisant des microservices (API) communiquants

Notre projet consiste donc à rechercher des articles de journaux en ligne concernant un lieu saisi

Membres du groupe

• Ibrahim AHAMADA
• David CHOCHO
• Tom FREMONT
• Bastian MARY
• Nils MOREAU--THOMAS

Les liens du projet

• Le git du projet
• La maquette Figma du site web
• Le Trello du projet (pour l'organisation)
• Le Google Drive du projet

Avertissements

⚠️ Le projet tourne sous Node v20.12.2
Le projet ne fonctionnera pas correctement en dessous de cette version

⚠️ Le site Web à été prévu pour la résolution 1920 x 1080
La disposition des éléments risques d'être problématique en dessous de cette résolution

⚠️ Le projet à été prévu pour les machines de l'IUT de Joffre sous Linux
Le fonctionnement du projet ne peut être garanti à 100% sur une machine différente

Structure du projet

API externes au projet

• NewsData : pour récupérer des articles concernant un lieu et / ou son pays
• OpenCage : pour récupérer les lieux ou pays selon le texte écrit

API internes au projet

• newsAPI : elle fait des requêtes à l'api NewsData et "nettoie" les résultats en enlevant les champs inutiles
• placeAPI : elle fait des requêtes à l'api OpenCage et "nettoie" les résultats en enlevant les champs inutiles
• userAPI : elle fait la gestion des comptes utilisateurs, elle se fait utiliser par le site Web
• externalAPI : elle fait des requêtes aux api newsAPI et placeAPI, elle se fait utiliser par le site Web

Autres

• tests : Les tests des API internes au projet (userAPI, placeAPI, newsAPI, externalAPI)
• newsradar : Le site Web qui utilise userAPI et externalAPI
• auto_refresh : pour actualiser automatiquement les limites d'appels à chaque API externes chaque jour (00:00) avec un délai de maximum 10 minutes pour tous les comptes utilisateurs
• des scripts .sh : pour exécuter tel ou tel chose

Infrastructure du projet

• Un serveur qui fait tourner le site Web sur le port 5173
• Un processus qui fait tourner auto_refresh
• Un serveur express qui fait tourner externalAPI sur le port 3000
• Un serveur express qui fait tourner newsAPI sur le port 3001
• Un serveur express qui fait tourner placeAPI sur le port 3002
• Un serveur express qui fait tourner userAPI sur le port 3003

Les commandes

Lancer le projet

1. Avoir la version 20.12.2 de NodeJS

2. Lancer le service mongodb

3. Lancer le script start_all.sh ./start_all.sh

OU

3. Ouvrir un terminal et se rendre dans externalAPI et faire npm run start
4. Ouvrir un terminal et se rendre dans newsAPI et faire npm run start
5. Ouvrir un terminal et se rendre dans placeAPI et faire npm run start
6. Ouvrir un terminal et se rendre dans userAPI et faire npm run start
7. Ouvrir un terminal et se rendre dans auto_refresh et faire node main.js
8. Ouvrir un terminal et se rendre dans le site Web et faire npm run start

Générer les docs

• Se rendre dans externalAPI et faire npm run generate-docs
  • Doc accessible à l'URL suivante
• Se rendre dans newsAPI et faire npm run generate-docs
  • Doc accessible à l'URL suivante
• Se rendre dans placeAPI et faire npm run generate-docs
  • Doc accessible à l'URL suivante
• Se rendre dans userAPI et faire npm run generate-docs
  • Doc accessible à l'URL suivante

Autres commandes

Vider la base de données

• Se rendre dans userAPI et faire npm run clear

Peupler la base de données

• Se rendre dans userAPI et faire npm run populate

Crédits

• Stackoverflow : pour apporter de nombreuse réponses sur des problèmes rencontrée
• Fontawesome : pour les icônes utilisées sur le site Web
• Google Fonts : pour fournir les polices utilisées sur le site Web