Broadcast your Infos with ease

InfoBroadcaster est une application web développé sur une stack NodeJS dont Express pour le backend, et React pour le front qui permet de résumer automatiquement les informations d'un article en lui fournissant l'url.

Cette application permet également de partager les informations résumées dans des bulles Rainbow. Ainsi pour pouvoir utiliser l'application, il est nécessaire de se prémunnir d'un compte Rainbow et de les utiliser pour intéragir avec l'application.

📂 /
├── 📂 API                   # Dossier contenant l'API avec les logiques de résumé et traduction
│   ├── 📂 logique           # Traitement des informations reçues par les routes et l'IA
│   ├── 📂 routes            # Route API qui vérifie le contenu, traite les requêtes
│   ├── 📂 tests             # Tests unitaires des routes et logique
│   ├── 📄 utils.js          # Script qui gère la couche de base de l'implémentation de l'IA
│   ├── 📄 index.js          # Fichier principal qui initialise l'application backend
│   ├── 📄 package.json      # Liste des dépendances Node.js
│   ├── 📄 package-lock.json # Verrouillage des dépendances pour des builds reproductibles
├── 📂 AI-Model              # Dossier contenant le modèle IA et possibilité de lancer en local
├── 📄 README.md             # Readme du repository

Pour lancer l'environnement backend en local, clonez le dépôt backend, naviguez dans le dossier API, et lancez la commande npm qui permet de lancer l'environnement backend.

git clone https://github.com/Info-Broadcaster/backend.git

cd backend/API/
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.

🏁 Ainsi, en local, l'environnement sera accessible depuis l'adresse http://localhost:3000

Pour lancer les tests unitaires du backend, lancez la commande suivante:

npm test

• Express Node.js pour le Backend
• Ollama comme package manager du modèle IA
• Jest comme framework de suite de tests

📂 /
├── 📂 public                  # Fichiers multimédia accessibles directement par les utilisateurs externes
├── 📂 src                     # Code source de l'application
│   ├── 📂 assets              # Fichiers multimédia utilisés en interne par le serveur
│   ├── 📂 components          # Composants réutilisables pour l'affichage
│   ├── 📂 functions           # Fonctions pour la gestion de l'authentification et de la logique métier
│── 📄 package.json            # Liste des dépendances Node.js
│── 📄 package-lock.json       # Verrouillage des dépendances pour des builds reproductibles

Pour lancer l'environnement front en local, clonez le repository frontend du projet puis lancez l'environnement.

git clone https://github.com/Info-Broadcaster/frontend.git

cd frontend/
npm run dev

🏁 Ainsi, en local, l'environnement sera donc accessible depuis l'adresse http://localhost:5173

• React comme framework JS pour la création des composants
• Vite comme moteur de développement

• Project User Stories
• Maquette Figma
• Documentation API Rainbow
• Ollama docs

• @bobylatruffe alias Fatih B.
• @Erestona alias Tanguy P.
• @ShortLegsFox alias Ian B.
• @Nerlake alias Léo H.
• @Vladimir9595 alias Vladimir S.
• @maxime-hell alias Maxime H.
• @EpitronX alias Jérémie M.
• @htregnagoCNAM alias Hugo T.
• @WRKT alias Winness R.