HelpDesk-AI

video.mp4

⚙️ Setup Instructions

Make sure Python 3.10+ is installed and accessible via py or python3.

1. Clone the repository

git clone <your-repo-url>
cd HelpDesk-AI

2. Setup Virtual Environment

# Create virtual environment
python -m venv .venv

# Activate virtual environment
# Windows
.venv\Scripts\activate

# Unix/MacOS
source .venv/bin/activate

3. Install Dependencies

Make sure you have uv installed.

uv sync

4. Run the Backend Server

py -m uvicorn backend.app.main:app --reload

5. Run the Frontend UI

py -m streamlit run frontend/streamlit_ui.py

---

🔐 Environment Variables

Create a .env file in the root directory with the following (example):

# Mongo DB
MONGODB_HOST_TEST="localhost"
MONGODB_PORT_TEST="27017"
MONGODB_DATABASE_NAME_TEST="grievances"


# Gemini
GEMINI_API_Key_TEST = "str"
GEMINI_MODEL_NAME_FLASH_TEST = "gemini-2.0-flash"

---

🧠 Powered By

• Gemini Flash (Google GenAI)
• FastAPI
• Streamlit
• MongoDB
• uv (fast dependency manager)

---

📌 TODO / Future Improvements

• Add login/authentication system
• Admin dashboard for complaint management
• Notification/email integration for updates
• Improve UI/UX with chat-like interface

---

📃 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Let me know if you want me to auto-generate a README.md file in your directory structure as well.