PhishCheck (Demo)

A lightweight Streamlit demo to triage potential phishing emails.

Quick start (local)

1. Create a virtual environment and activate it:

python3 -m venv .venv
source .venv/bin/activate

2. Install dependencies:

pip install -r requirements.txt

3. Run the app:

streamlit run code_v2.py

Deploy to Streamlit Community Cloud

1. Create a GitHub repository and push this project (instructions below).
2. Sign into https://share.streamlit.io and select your GitHub repo.
3. If you use the Hugging Face Inference API, do NOT commit tokens. Instead set secrets in Streamlit Cloud:
   • Go to your app page > "Settings" > "Secrets" and add HF_TOKEN.
   • In the app, use st.secrets["HF_TOKEN"] or set the token in the sidebar at first run.

Commands to push to GitHub (example):

git init
git add .
git commit -m "Initial PhishCheck demo"
# create a repo on GitHub and then:
git remote add origin https://github.com/<your_username>/<repo>.git
git branch -M main
git push -u origin main

Notes

• This is a demo tool; do not rely on it for automated blocking.
• If you enable the Hugging Face option, you are sending email content to their servers — redact or avoid sending sensitive content.