Skip to content

Meharsh7804/DeskMate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

6 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

DeskMate - Your Campus Professor Tracker

πŸ“Œ Project Overview

DeskMate helps students locate professors on campus by checking their availability and seating information via an interactive chatbot. It eliminates the hassle of manually searching for faculty members by leveraging AI-powered search and response capabilities. Students can upload department timetables in PDF format and instantly ask questions about a professor’s schedule.

The system uses Google Gemini AI for intelligent responses and FAISS for quick and efficient vector searches. With a user-friendly Streamlit-based UI, DeskMate provides a seamless experience for students to find the right professor at the right time.

πŸš€ Features

  • Upload department timetables (PDF)

  • Ask queries about professor availability

  • AI-powered responses using Google Gemini API

  • Fast vector search with FAISS

  • Streamlit-based interactive UI

πŸ› οΈ Installation Guide

1️⃣ Create Virtual Environment

python -m venv venv
source venv/bin/activate  # On Windows use: venv\Scripts\activate

2️⃣ Clone Repository

git clone https://github.com/yourusername/deskmate.git
cd deskmate

3️⃣ Install Dependencies

pip install -r requirements.txt

4️⃣ Set Up API Key
Create a .env file in the root directory and add:

GOOGLE_API_KEY=your_api_key_here

πŸ“‚ Project Structure

πŸ“¦ deskmate
β”œβ”€β”€ πŸ“œ main.py             # Streamlit app entry point
β”œβ”€β”€ πŸ“œ requirements.txt    # Required dependencies
β”œβ”€β”€ πŸ“œ .env                # API key configuration
└── πŸ“‚ faiss_index         # Local vector storage

▢️ Run DeskMate

streamlit run main.py

❓ Troubleshooting

Invalid API Key?

Check .env file.

No Response from AI?

Ensure internet access & valid API key.

PDF Not Processing?

Confirm file format and retry.

πŸ› οΈ Contributing

Pull requests are welcome! Follow the GitHub workflow:

  • Fork the repository

  • Create a new branch (git checkout -b feature-branch)

  • Commit changes (git commit -m "Added new feature")

  • Push (git push origin feature-branch)

  • Open a pull request

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages