Skip to content

RohanSreelesh/StudyBytes

Repository files navigation

StudyBytes

An AI-powered platform that transforms learning materials into engaging, short-form educational videos.

Features

  • Upload learning materials (PDF, TXT)
  • AI processing to generate personalized educational videos
  • Short-form video player
  • Video preview on hover and intuitive controls
  • Dark mode support
  • Modern, intuitive user interface

Getting Started

Prerequisites

  • Node.js 14.x or higher
  • npm or yarn
  • Python 3.8+ (for backend)

How to run the project

Installation

  1. Clone the repository:
git clone https://github.com/RohanSreelesh/StudyBytes.git
cd StudyBytes
  1. Setup a python virtual environment with Python 3.12

Ideally it is named as ".venv"

  1. Setup and rename "backend/example.env" to "backend/.env"

  2. Install dependencies:

Frontend

npm i

Backend

cd backend

pip install -r requirements.txt
  1. Run the Application

Run Frontend

npm run dev

Run Backend

cd backend

py main.py
  1. Open [http://localhost:3000] in your browser to see the application.

Tech Stack

  • Frontend:

    • Next.js with React
    • Tailwind CSS for styling
    • TypeScript for type safety
    • react-dropzone for file uploads
  • Backend:

    • FastAPI (Python)
    • Pydantic for data validation

Project Structure

  • /src: Frontend code
    • /app: Next.js app router pages
    • /components: Reusable React components
    • /lib: Utility functions and shared logic
  • /backend: Python FastAPI server
    • main.py: Main API implementation
    • requirements.txt: Python dependencies
    • uploads: Directory where uploaded files are stored (created automatically)

API Endpoints

  • GET /api/health: Health check endpoint
  • POST /api/process: Process uploaded files and generate videos
    • Accepts assignment files and optional learning materials
    • Returns an array of generated videos
  • GET /api/videos: Get list of all available processed videos
  • /videos/*: Static file serving for processed video files

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •