Spam Detector

Description du projet

Spam Detector est une application web permettant d’analyser des emails pour détecter s’ils sont du spam, du phishing ou des promotions. L'application offre des fonctionnalités d’analyse via un formulaire ou par glisser-déposer de fichiers, et conserve un historique des analyses effectuées.

---

Fonctionnalités

• Analyse d'emails :

  • Saisie manuelle (objet et contenu) via un formulaire.
  • Import de fichiers (.json, .txt, .eml, .docx) pour analyse.

• Résultats détaillés :

  • Probabilités pour chaque catégorie (spam, phishing, promotion).
  • Analyse des mots-clés et des liens détectés (avec identification des liens malveillants).

• Historique :

  • Consultation des analyses précédentes.

• Authentification sécurisée :

  • Inscription et connexion via des comptes utilisateurs.

• Collaboration :

  • Projet open-source, contributions ouvertes à tous. Voir CONTRIBUTING.md.

---

Comment lancer le projet (de A à Z)

1. Pré-requis

• Node.js version 14 ou supérieure
• Docker
• Une instance MongoDB locale ou distante

---

2. Cloner le projet

Cloner le dépôt GitHub sur votre machine locale :

git clone <url-du-repository>
cd spam-detector-project-AOS

---

3. Configurer les environnements

Par défaut, des fichiers .env sont présent à la racine des répertoires auth-services et spam-detector-backend, cependant ils peuvent ne pas correspondre à votre environnement. Alors créez un fichier .env à la racine de chaque dossier (auth-services, spam-detector-backend) et ajoutez-y les variables nécessaires.

Exemple de fichier .env pour auth-services :

MONGODB_URI=mongodb://localhost:27017/auth-service
JWT_SECRET=clesecrete

Exemple de fichier .env pour spam-detector-backend :

MONGODB_URI=mongodb://localhost:27017/spam-detector
VIRUSTOTAL_API_KEY=c59ea4bc9b1db78f7492244ce9425458a287efdf9fe80d46097d0c11aaad2712
JWT_SECRET=clesecrete
FILE_ANALYZER_PORT=5002
PORT=5001

---

4. Configurer la base de données avec MongoDB

L'application utilise MongoDB comme base de données principale. Vous avez deux options pour configurer MongoDB : utiliser MongoDB Atlas (hébergement cloud) ou une instance locale.

---

Option 1 : Utiliser MongoDB Atlas (hébergement cloud)

1. Créer un compte MongoDB Atlas :

   • Rendez-vous sur MongoDB Atlas et créez un compte.

2. Créer un cluster gratuit :

   • Suivez les instructions pour créer un cluster.
   • Une fois le cluster créé, cliquez sur Connect et sélectionnez Connect Your Application.

3. Obtenir l’URI MongoDB :

   • Copiez l’URI généré (par exemple : mongodb+srv://<username>:<password>@cluster0.mongodb.net/myFirstDatabase).

4. Remplir le fichier .env :

   • Remplacez <username>, <password> et myFirstDatabase par vos informations MongoDB.
   • Exemple pour auth-services :

     MONGODB_URI=mongodb+srv://user-test:[email protected]/auth-service
     

---

Option 2 : Utiliser une instance MongoDB locale

1. Installer MongoDB :

   • Téléchargez et installez MongoDB depuis le site officiel.

2. Lancer le service MongoDB :

   • Sur votre machine, démarrez MongoDB. Par défaut, MongoDB est disponible sur mongodb://localhost:27017.

3. Configurer le fichier .env :

   • Remplissez le fichier .env avec l’URI de votre instance locale.
   • Exemple pour auth-services :

     MONGODB_URI=mongodb://localhost:27017/auth-service
     

---

Préférez l'option 1 pour maximiser ses chances de comptatibilité avec la version du code présente sur le Git

---

Test de la connexion MongoDB

Pour vérifier que MongoDB est bien configuré :

1. Lancez le projet avec Docker :

   docker-compose up

2. Vérifiez les logs dans la console pour vous assurer que les services auth-services et spam-detector-backend se connectent correctement à MongoDB.

---

5. Lancer le projet avec Docker

Construire les images :

docker-compose build

Lancer les services :

docker-compose up

Les services seront disponibles sur :

• Frontend : http://localhost:5173
• Backend : http://localhost:5001
• Auth-service : http://localhost:4000

---

6. Fonctionnalités de l'application

Accès à l'application

• Rendez-vous sur http://localhost:5173.

Analyse d’un email

1. Connectez-vous ou créez un compte.
2. Saisissez un email dans le formulaire ou glissez-déposez un fichier dans la zone dédiée.
3. Consultez les résultats d’analyse.

Historique

• Accédez à la section Historique pour voir les analyses précédentes.

---

Contribution

Nous accueillons les contributions ! Consultez CONTRIBUTING.md pour plus de détails.

---

Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.