Skip to content

BryanLim0214/StudyGuideAI

Repository files navigation

📚 StudyGuideAI

Transform any document into a comprehensive, beginner-friendly study guide powered by AI.

Live Demo


🎯 The Problem We Solve

Traditional summarization tools often:

  • Skip slides or pages — missing crucial information
  • Lose context from diagrams, code blocks, and images
  • Produce content that's either too dense or too shallow
  • Fail to explain technical concepts in simple terms

StudyGuideAI is different. We process every single page of your document, ensuring nothing gets lost. Our AI analyzes text, images, diagrams, and code to generate comprehensive study materials personalized to your learning style.


✨ Features

Feature Description
📄 Multi-Format Support Upload PPT, PPTX, PDF, DOC, or DOCX files
🧠 Smart AI Processing Uses Google's Gemini 2.0 Flash to analyze every page
📊 Visual Explanations Describes diagrams, charts, and images in detail
💻 Code Breakdown Explains code blocks line-by-line for beginners
📝 Two Study Modes Simplified (quick review) or Detailed (deep study)
📥 PDF Export Download your study guide as a formatted PDF
🎮 Mini-Games Play Memory, Snake, or Typing games while processing
🌙 Dark Mode Easy on the eyes for late-night studying
📱 Mobile Responsive Works great on phones, tablets, and desktops

🖼️ Screenshots

Application Interface

Click the image to try it live!

StudyGuideAI Homepage

HTML Preview (Interactive)

Real-time preview with syntax-highlighted code blocks and formatted sections

HTML Preview

PDF Output (Downloadable)

Clean, formatted PDF with proper headings, code blocks, and page numbers

PDF Output


🚀 How to Use

  1. Get Your API Key (Free)

    • Go to Google AI Studio
    • Sign in with your Google account
    • Click "Create API Key"
    • Copy your key
  2. Add Your Key

    • Expand "About StudyGuideAI" on the website
    • Paste your API key and click "Save Key"
    • Your key is stored locally in your browser (never sent to any server)
  3. Upload Your Document

    • Drag & drop or click to browse
    • Supports: PPT, PPTX, PDF, DOC, DOCX
  4. Choose Your Style

    • Simplified: Quick review, beginner-friendly language
    • Detailed: In-depth explanations, comprehensive coverage
  5. Generate & Download

    • Click "Generate Study Guide"
    • Play mini-games while you wait!
    • Preview your guide and download as PDF

🛠️ Tech Stack

Technology Purpose
Gemini 2.0 Flash AI-powered content generation
Vite Fast development and build tooling
PDF.js PDF document parsing
JSZip PowerPoint file extraction
Mammoth.js Word document processing
jsPDF PDF generation and export

📋 Known Limitations

  • Large documents (100+ pages): May take 5-10 minutes to process
  • Rate limiting: Very large batches may hit API limits — wait a few minutes and retry
  • Complex layouts: Some unusual slide layouts may not extract perfectly
  • Memory usage: High-resolution images may use significant RAM

🏃 Running Locally

# Clone the repository
git clone https://github.com/BryanLim0214/StudyGuideAI.git
cd StudyGuideAI

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

🔒 Privacy & Security

  • Your API key stays in YOUR browser — stored in localStorage only
  • No server-side storage — documents are processed client-side
  • No tracking — we don't collect any personal data

📞 Support

Having issues or questions? Visit pplim.com for support.


📄 License

MIT License — feel free to use and modify!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published