Skip to content

weebao/slideprof

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SlideProf

Logo An AI that can draw while answering your toughest questions!

What does it do?

Basically, you upload your lecture slides, drag and drop your most confusing parts, and SlideProf will answer while drawing and writing directly on your slides!

Demo

Check out our demo on YouTube to see SlideProf in action:

SlideProf Demo

Installation

Backend (server folder)

  1. Navigate to the server directory:
cd server
  1. Create a virtual environment:
python -m venv venv
  1. Activate the virtual environment:
  • On Windows:
    venv\Scripts\activate
  • On macOS/Linux:
    source venv/bin/activate
  1. Install the required dependencies:
pip install -r requirements.txt

Backend (model folder)

  1. Navigate to the model directory:
cd model
  1. Create a virtual environment:
python -m venv venv
  1. Activate the virtual environment:
  • On Windows:
    venv\Scripts\activate
  • On macOS/Linux:
    source venv/bin/activate
  1. Install the required dependencies:
pip install -r requirements.txt

Frontend (client folder)

  1. Navigate to the client directory:
cd client
  1. Install the required dependencies:
npm install

Running the Development Server

  1. Start the backend server:
cd model
# Ensure the virtual environment is activated
python app.py
  1. Start the frontend development server:
cd client
npm run dev

Now, you should have both the backend and frontend servers running for development.

Architecture

Here's a high-level overview of the SlideProf architecture:

Architecture

The architecture consists of three main components:

  1. Frontend (Client): Built with modern web technologies, it provides an intuitive interface for users to interact with SlideProf.

  2. Backend (Server): Handles the core logic, including processing user requests, managing data, and serving the AI model's predictions. It acts as a glue sticking the frontend with the model, making sure that user inputs are correctly processed and that the model's outputs are appropriately formatted and sent back to the frontend.

  3. Model: The AI component that performs the drawing and answering tasks, leveraging advanced machine learning techniques. The model processes the input data, scans the surrounding area to make sure there is space to draw, and then generates the necessary visual and textual explanations, and sends them back to the backend for further processing and delivery to the frontend.

Each component communicates seamlessly to deliver a smooth and efficient user experience.

Members