metadata

title: Phish Sherlock
emoji: 🕵️
colorFrom: gray
colorTo: yellow
sdk: gradio
sdk_version: 5.23.1
app_file: app.py
pinned: false

🦆 Phishing Email Detection & Awareness App

Welcome to the Phishing Email Detection & Quiz App – a smart, multilingual web tool that helps users identify phishing emails, learn security best practices, and test their skills interactively!

🚀 Live Demo

Visit the deployed app here: **🔗 Hugging Face Space Link

🛡️ Features

🔍 Email Analysis: Detects phishing risk from subject and body.
🌍 Multilingual Support: Works with English, Spanish, and French emails.
🗣️ Explanation Engine: Tells you why the email is safe or dangerous.
🕵️‍♂️ Gamified Quiz: Test your knowledge with phishing examples.
🎓 "Did You Know?" Security Tips: Learn new cyber safety facts each time.
📊 Session-Based Scoring: Track how many quiz answers you get right.
🦆 Duck Investigator Vibes: Educational tone with fun “Quack Quack!” feedback.

🧩 Tech Stack

Frontend: HTML + CSS
Backend: FastAPI (Python)
ML Model: Scikit-learn Phishing Classifier
Deployment: Hugging Face Spaces (Docker SDK)

📁 File Structure

├── app.py # FastAPI server logic ├── index.html # Frontend UI ├── style.css # Styling ├── duck_investigator.png # Icon ├── phishing_classifier.pkl # ML model ├── vectorizer.pkl # TF-IDF vectorizer ├── full_test_predictions_cleaned.csv # Quiz dataset ├── requirements.txt # Dependencies ├── README.md # This file

yaml Copy Edit

🛠️ Run Locally

git clone https://huggingface.co/spaces/your-username/phishing-detector
cd phishing-detector
pip install -r requirements.txt
python app.py
Then visit: http://127.0.0.1:7860

🤖 Why Hugging Face Spaces?
✅ Free & public ML app hosting

✅ Great for FastAPI & Docker apps

✅ Easy collaboration and showcasing

✅ Secure & scalable

👤 Author
Built by Richard Kusi Ansah