Info Broadcaster Backend

Organisation du projet

/
├── API                   # Dossier contenant l'API avec les logiques de resumé et traduction
  └── package.json        # Liste des dépendances Node.js
  └── package-lock.json
├── AI-Model              # Modèle IA
├── postman-api           # Fichier  à importer dans Postman pour tester les requêtes
├── README.md             # Readme du repository

Sous-dossier API

• Logique: Partie logique, traitement des informations reçues via les routes.
  • Exemple: Résumé d'un article avec un prompt comme "Résume l'article suivant" et envoi du lien à l'IA.
• Routes: Porte d'entrée pour les opérations, vérifie le contenu de la requête avant de l'envoyer à l'IA pour traitement.
  • Exemple: Résumé d'un article avec en paramètre le lien de l'article, retournant un JSON contenant le résumé en appelant la logique.

Note: Il est impératif de ne pas mélanger la logique et les routes afin de préserver une bonne séparation des responsabilités.

Sous-dossiers du modèle IA (AI-Model)

• Dockerfile:
  Gère la création de l'image Docker pour le modèle IA, définissant l'environnement et les dépendances nécessaires.

• Makefile:
  Fournit des commandes pour gérer l'environnement du modèle IA, comme le démarrage, l'arrêt et d'autres opérations.

• docker-compose.yaml:
  Fichier pour orchestrer les conteneurs Docker, avec des configurations pour exécuter le modèle IA.

• install.sh:
  Script shell qui automatise l'installation des dépendances ou la configuration de l'environnement nécessaire pour le modèle IA.

Fichiers du dossier backend

• index.js: Fichier principal qui initialise l'application, contenant les constantes (comme le numéro de port).
• .gitignore: Fichier qui définit les parties à ignorer par Git lors des push/pull.

---

Developpez localement

Pour lancer l'environnement backend en local, naviguez dans le dossier API, et lancez les commandes suivantes:

npm start

Pour avoir un reload automatique du serveur NodeJS après modification des fichiers:

npm run local

N.B: Cette commande est un alias du script node qui lancera nodemon.

---

Technologies utilisées

• Node.js express pour le Backend
• Ollama pour le package manager du modèle IA

---

User Stories

• US01: La page d'insertion de lien a été créée. La traduction en différentes langues est en cours.
• US03: Vérification des initiales des langues.

---

Ressources importantes

• Lien Excel des User Stories
• Lien Maquette Figma
• Liens Utiles - TensorFlow.NET
• Documentation API Rainbow

---