LecGen AI - Intelligent Lecture Assistant

LecGen AI is a powerful tool designed to transform lecture recordings (YouTube links, video files, or audio files) into structured study materials.

Features

• Transcription: High-accuracy transcription using OpenAI's Whisper model.
• Summarization: Smart summaries that capture the essence of the lecture.
• PYQ Analysis: Intelligent analysis of Previous Year Question papers with:
  • Topic Clustering: ML-powered grouping of related questions.
  • Smart Naming: Context-aware expansion of topic names (e.g., "M" → "Memory Management").
  • Diagram Support: Automatic extraction and inline rendering of diagrams and graphs.
  • Question Rewriting: Transformation of vague questions into clear, context-rich queries.
  • Curated Resources: Direct links to verified tutorials (GeeksforGeeks, TutorialsPoint) for every topic.
  • Difficulty Classification: Categorization into Standard, Important, and Critical levels.
• Notes Generation: Structured notes for easy review.
• Quiz Generation: AI-generated questions and answers to test your knowledge.
• Flashcards: Interactive flashcards for active recall.

🚀 Getting Started

Prerequisites

• Python 3.10+
• Node.js & npm
• FFmpeg: Required for audio processing. Download it from ffmpeg.org and add it to your system PATH.

Installation & Setup

1. Clone the Repository:

   git clone https://github.com/shridipa-codes/LecGenAICTE.git
   cd LecGenAICTE

2. Backend Environment Setup: Create a virtual environment and install the required dependencies:

   python -m venv venv
   
   # Windows:
   .\venv\Scripts\activate
   
   # Linux/Mac:
   source venv/bin/activate
   
   # Install Python packages:
   pip install -r requirements.txt

3. Frontend Setup: Navigate to the frontend directory and install dependencies:

   cd frontend
   npm install
   cd ..

Running the App

Recommended: React + FastAPI (Modern Stack)

This is the new modern interface built with React and FastAPI.

1. Install Frontend Dependencies:

   cd frontend
   npm install
   cd ..

2. Start both Backend and Frontend: Run the handy batch script:

   .\start_app.bat

   Or manually:

   • Backend: python -m uvicorn api.main:app --reload --port 8000
   • Frontend: cd frontend && npm run dev

📚 API Documentation

The backend provides comprehensive documentation:

• Premium Visual Reference: http://localhost:8000/api-reference (Highly Recommended)
• Interactive Swagger UI: http://localhost:8000/docs
• ReDoc Technical Manual: http://localhost:8000/redoc

For a detailed list of endpoints and technical details, see API_DOCUMENTATION.md.

Legacy: Streamlit Frontend

To run the legacy Streamlit interface:

streamlit run streamlit_app.py

CLI Interface

To run the command-line interface:

python main.py

Tech Stack

• Frontend: React JS + Vite + Lucide Icons
• Backend: FastAPI
• Transcription: OpenAI Whisper
• AI Models: Hugging Face Transformers (BART, T5, RoBERTa)
• Audio Processing: Pydub
• Video Download: yt-dlp