🎓 SmartStudy (Study-Buddy) — AI Study Assistant & Material Hub

SmartStudy is an all-in-one, AI-powered study platform designed to keep all your learning materials in one place. Students can upload PDFs and notes, read them directly inside the platform, auto-generate interactive 3D flippable flashcards and question banks, practice quizzes with real-time feedback, and chat with buddyAI — without ever leaving the website!

---

✨ Features

📄 1. Study Material Hub & Document Reader

• Subject Management: Organize study materials under custom, color-coded subject categories (e.g. Computer Science & AI, Physics & Engineering).
• Backend File Processing: Upload PDF, TXT, and Markdown files with server-side text extraction powered by pypdf.
• In-App Reader: Read study notes and PDFs directly in the dashboard reader without needing third-party applications.

🎴 2. AI Interactive Flashcards Suite

• 3D Card Flip Animation: Smooth flippable cards with Questions on the front and Answers/Explanations on the back.
• Study Mode: Card navigation (Previous, Flip, Next), card deck list, and mastery tracking (Mark Mastered vs Needs Practice) with a real-time progress bar.
• AI Card Generation: One-click "Generate Flashcards from Notes" analyzes uploaded materials and creates custom card decks automatically.

📝 3. AI Question Bank & Practice Test Simulator

• Interactive Quiz Player: Multiple-choice question practice tests with option selection, immediate correct/incorrect answer states, score counter, and document-backed explanations.
• Results Dashboard: Final score percentage (e.g. 80%), performance feedback, and one-click quiz retake functionality.
• Saved Question Banks: Access saved practice test sets per subject anytime.

🤖 4. buddyAI Contextual Study Assistant

• Context-Aware Drawer: Floating AI study assistant drawer accessible across all screens.
• Quick Action Chips:
  • 📝 Summarize Note: High-yield bullet points and key takeaways.
  • 🎴 Make 5 Flashcards: Auto-extract key definitions and Q&A.
  • 🎯 Build Quiz: Create practice multiple-choice tests.
  • 💡 Explain Simply: Step-by-step breakdowns with analogies.
• Smart Fallback Engine: Works out-of-the-box with OpenAI API (gpt-4o-mini) or offline via local heuristic document parsing.

---

🛠️ Technology Stack

• Backend: Python 3, Flask 3.0, pypdf, python-dotenv, openai
• Frontend: HTML5, Vanilla JavaScript, Vanilla CSS (Custom Glassmorphism & 3D Flip Animations), TailwindCSS CDN
• Storage: LocalStorage API for persistent state, Flask backend file uploads (/uploads)

---

🚀 Quick Start Guide

1. Prerequisites

• Python 3.9 or higher

2. Installation

# Clone repository
git clone https://github.com/qwerty274/SmartStudy.git
cd SmartStudy

# Install Python dependencies
pip install -r requirements.txt

3. Environment Setup (Optional for OpenAI AI API)

Create a .env file in the project root:

OPENAI_API_KEY=your_openai_api_key_here

Note: If no API key is provided, SmartStudy automatically uses its built-in offline smart heuristic parsing engine.

4. Running the Platform

python app.py

Open your browser and navigate to: http://127.0.0.1:5000/ or http://127.0.0.1:5000/dashboard.html.

---

📑 API Endpoints

Endpoint	Method	Description
GET /	GET	Serves landing page (index.html)
POST /api/upload	POST	Uploads PDF/TXT notes, extracts document text, saves to /uploads
POST /api/bot	POST	AI bot endpoint for summarize, flashcards, quiz, chat, and explain actions
GET /uploads/<filename>	GET	Serves uploaded PDF and study material files

---

📜 License

MIT License. Built for student productivity and learning excellence!