Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 

Repository files navigation

StudySurf 🏄‍♂️

AI-Powered Personalized Learning Platform |

An innovative learning application that transforms educational videos into personalized, multi-format learning experiences using advanced AI. StudySurf adapts content to individual learning styles, accessibility needs, and cultural contexts—making education truly inclusive.


DEMO VIDEO

WhatsApp.Video.2025-10-16.at.12.27.57.AM.1.mp4

🎯 What is StudySurf?

StudySurf is an AI-based interactive learning platform that harnesses LLMs to convert any educational video into 6 distinct, personalized learning formats:

  1. Analogy-Based Explanations - Relate concepts to your field of study
  2. Code/Equation Cheatsheets - Quick reference guides
  3. Optimized Visualizations - Diagrams tailored for visual learners
  4. Real-World Applications - Practical use cases
  5. Key Concept Summaries - Memory aids and quick notes
  6. Personalized Quizzes - Self-assessment tools

Key Features

Personalized Learning - Adapts to academic level, language preference, and learning style
🌍 Multi-Language Support - Content in 20+ languages with cultural adaptations
Accessibility First - Dyslexia-friendly content and alternative formats
Lightning Fast - 70% speed boost through parallel AI processing
📱 Works for All Subjects - Processes educational content across any domain


🛠️ Tech Stack

Component Technology
Backend FastAPI, Python
Frontend React/Vue (npm)
AI/LLM Google Gemini 2.5 (Pro & Flash)
Audio Processing ElevenLabs Speech-to-Text
Video Processing FFmpeg
Database Firestore
Orchestration FastAPI (7-Agent system)

🚀 Quick Start

Prerequisites

  • Python 3.8+
  • Node.js 16+
  • Google Gemini API key
  • ElevenLabs API key
  • FFmpeg installed on your system

Backend Setup

# Clone the repository
git clone https://github.com/Harsh22428/StudySurf.git
cd StudySurf

# Create virtual environment
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Set up environment variables
cp .env.example .env
# Edit .env and add your API keys:
# GOOGLE_GEMINI_API_KEY=your_key_here
# ELEVENLABS_API_KEY=your_key_here
# FIREBASE_CREDENTIALS=your_credentials_here

# Run the development server
fastapi run dev main.py

Backend runs at: http://localhost:8000
API Docs available at: http://localhost:8000/docs (interactive Swagger UI)

Frontend Setup

# Navigate to frontend directory
cd frontend

# Install dependencies
npm install

# Set up environment variables
cp .env.example .env
# Add your backend URL and any other configs

# Run development server
npm run dev

Frontend runs at: http://localhost:5173 (or your configured port)


📋 Environment Variables

Create a .env file in the root directory:

# Google Gemini API
GOOGLE_GEMINI_API_KEY=your_gemini_api_key_here

# ElevenLabs Audio Processing
ELEVENLABS_API_KEY=your_elevenlabs_api_key_here

# Firebase/Firestore
FIREBASE_PROJECT_ID=your_project_id
FIREBASE_PRIVATE_KEY=your_private_key
FIREBASE_CLIENT_EMAIL=your_client_email

# Server Configuration
BACKEND_URL=http://localhost:8000
FRONTEND_URL=http://localhost:5173

🏗️ Architecture

7-Agent AI System

StudySurf employs a coordinated system of specialized AI agents:

  1. Audio Analysis Agent - Extracts and understands audio content using ElevenLabs
  2. Explanation Agent - Creates field-specific analogies and explanations
  3. Visualization Agent - Generates diagrams and charts for visual learners
  4. Equations Agent - Produces code/equation cheatsheets
  5. Applications Agent - Identifies real-world use cases
  6. Summary Agent - Creates key concept memory aids
  7. Quiz Agent - Generates personalized assessment questions

All agents work in parallel, achieving 70% faster processing than sequential execution.

Data Flow

Video Input
    ↓
FFmpeg (Audio Extraction)
    ↓
ElevenLabs (Speech-to-Text)
    ↓
7-Agent AI System (Parallel Processing)
    ↓
Personalization Engine
    ↓
6 Learning Formats
    ↓
Firestore (Storage)
    ↓
Frontend Display

📚 API Documentation

FastAPI automatically generates interactive API documentation:

  • Swagger UI: http://localhost:8000/docs
  • ReDoc: http://localhost:8000/redoc

All endpoints are documented with request/response examples.


🎓 Project Status

Status: MVP (Minimum Viable Product)
Hackathon: Hack O'Gravity
Team: Tech Hunter

  • Utkarsh Jaiswal
  • Harsh Sharma
  • Raghvendra Singh
  • Sudhanshu Shukla

Roadmap

  • Virginia Tech pilot program integration
  • Interactive data visualizations
  • Instructor dashboard with student progress insights
  • Expansion to 20+ languages
  • University LMS integrations
  • Learning outcome research & validation

🎯 Key Achievements

  • 70% Speed Boost - Parallel processing reduces video-to-content time from 2+ minutes to under 45 seconds
  • 100% Subject Coverage - Works with educational content across all domains
  • 95% Consistency - Structured AI prompts ensure reliable, predictable outputs
  • Multi-Platform Support - FFmpeg handles all video formats seamlessly
  • Accessibility Focus - Dyslexia-friendly and culturally adapted content

🤝 Contributing

We welcome contributions! To get started:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Development Guidelines

  • Follow PEP 8 for Python code
  • Use descriptive commit messages
  • Add tests for new features
  • Update documentation as needed

Happy Hacking! 🚀

About

An innovative learning application that transforms educational videos into personalized, multi-format learning experiences using advanced AI. StudySurf adapts content to individual learning styles, accessibility needs, and cultural contexts—making education truly inclusive.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages