Skip to content

About

A comprehensive AI-powered study assistant that transforms your PDF study materials into interactive learning tools including flashcards, practice exams, and an intelligent chat interface powered by Google Gemini AI.

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Latest commit

 

History

12 Commits

Folders and files

Repository files navigation

StudyMate AI

A comprehensive AI-powered study assistant that transforms your PDF study materials into interactive learning tools including flashcards, practice exams, and an intelligent chat interface powered by Google Gemini AI.

Features

  • 📄 PDF Upload & Processing: Upload multiple PDF documents for AI analysis
  • 🃏 Smart Flashcards: Generate flashcards with difficulty levels (Easy, Medium, Hard)
  • 📝 Practice Exams: Create exams with various question types (Multiple Choice, Short Answer, Fill-in-the-Blank)
  • 💬 AI Chat Interface: Ask questions about your study materials and get instant answers
  • 📊 Progress Tracking: Monitor your exam performance and study progress over time
  • 🎯 Personalized Learning: AI adapts to your learning patterns and provides recommendations

Technology Stack

Backend

  • FastAPI: Modern, fast web framework for building APIs
  • LangChain: Framework for developing applications with large language models
  • FAISS: Vector database for efficient similarity search
  • Google Gemini AI: Advanced language model for intelligent responses
  • HuggingFace Transformers: For embeddings and NLP tasks

Frontend

  • React 18: Modern JavaScript library for building user interfaces
  • Vite: Fast build tool and development server
  • Tailwind CSS: Utility-first CSS framework for styling
  • Axios: HTTP client for API communication
  • React Router: Client-side routing
  • Lucide React: Beautiful icon library

Project Structure

StudyMate/
├── backend/
│   ├── app.py                    # FastAPI application
│   ├── requirements.txt          # Python dependencies
│   ├── exam_history.csv          # Exam performance tracking
│   ├── uploads/                  # PDF upload directory
│   ├── studybuddy_vectordb/      # FAISS vector database
│   ├── exams/                    # Generated exam files
│   └── flashcards/               # Generated flashcard sets
├── frontend/
│   ├── src/
│   │   ├── components/           # React components
│   │   │   ├── ChatInterface.jsx # AI chat interface
│   │   │   ├── DocumentUpload.jsx# PDF upload component
│   │   │   ├── ExamManager.jsx   # Exam creation & taking
│   │   │   ├── FlashcardManager.jsx # Flashcard generation
│   │   │   ├── ExamHistory.jsx   # Progress tracking
│   │   │   └── HomePage.jsx      # Dashboard
│   │   ├── services/             # API client
│   │   ├── App.jsx               # Main app with sidebar
│   │   └── main.jsx              # Entry point
│   ├── public/                   # Static assets
│   └── package.json              # Node.js dependencies
├── modules/
│   └── studyBuddyAI.py          # Core AI functionality
└── README.md                     # This file

Setup Instructions

Prerequisites

  1. Python 3.8+ installed on your system
  2. Node.js 16+ and npm installed
  3. Google Gemini API Key - Get your API key from Google AI Studio

Backend Setup

  1. Navigate to the backend directory:

    cd backend
  2. Create a virtual environment:

    python -m venv venv
  3. Activate the virtual environment:

    # On Windows:
    venv\\Scripts\\activate
    
    # On macOS/Linux:
    source venv/bin/activate
  4. Install Python dependencies:

    pip install -r requirements.txt
  5. Create a .env file in the backend directory:

    cp .env.example .env

    Then edit the .env file and add your Google Gemini API key:

    GOOGLE_API_KEY=your_actual_api_key_here
    API_PORT=8001
  6. Start the FastAPI server:

    python app.py

The backend API will be available at http://localhost:8001

Frontend Setup

  1. Navigate to the frontend directory:

    cd frontend
  2. Install dependencies:

    npm install
  3. Start the development server:

    npm run dev

The frontend will be available at http://localhost:5174

Usage Guide

1. Upload Study Materials

  • Navigate to the "Upload Study Materials" page from the sidebar
  • Drag and drop or select PDF files
  • Wait for processing and vector database creation
  • View uploaded files in your dashboard

2. Chat with Your Documents

  • Use the "AI Chat Assistant" from the sidebar
  • Select which files you want to include in your learning session
  • Ask questions about your study materials
  • Get instant AI-generated answers powered by Google Gemini
  • Use suggested questions for quick start

3. Generate Flashcards

  • Go to the "Flashcard Manager" page
  • Enter a topic/subject from your uploaded materials
  • Choose the number of cards and difficulty level
  • Click "Generate Flashcards"
  • Study with interactive flip cards and track your progress

4. Create Practice Exams

  • Visit the "Exam Center" page
  • Set the page range from your PDFs (e.g., pages 1-20)
  • Choose number of questions and question types
  • Generate and take the exam with timer functionality
  • Review your results with detailed feedback

5. Track Your Progress

  • Check the "Progress Tracker" page to see your exam performance
  • View detailed statistics including scores, completion times, and trends
  • Monitor improvement over time with visual charts
  • Get insights into your learning patterns

API Endpoints

Documents

  • POST /upload-pdfs - Upload PDF files
  • GET /uploaded-files - Get list of uploaded files

Flashcards

  • POST /generate-flashcards - Generate flashcard set
  • GET /flashcards - Get all flashcard sets

Exams

  • POST /generate-exam - Generate practice exam
  • GET /exams - Get all available exams
  • POST /submit-exam - Submit exam answers for grading

Chat & History

  • POST /query - Ask questions about documents
  • GET /exam-history - Get exam performance history

Configuration

Environment Variables

You can configure the following environment variables:

# Backend (.env file in backend directory)
GOOGLE_API_KEY=your_google_gemini_api_key  # Required: Get from Google AI Studio
API_PORT=8001                              # Backend port (default: 8001)

# Frontend
VITE_API_URL=http://localhost:8001         # Backend URL (if needed to customize)

Customization

  • AI Model: Configure Google Gemini model version in backend/app.py
  • Styling: Modify Tailwind configuration in frontend/tailwind.config.js
  • API Base URL: Update in frontend/src/services/api.js
  • Sidebar Theme: Customize gradient colors and navigation in frontend/src/App.jsx

Troubleshooting

Common Issues

  1. "Import 'langchain' could not be resolved"

    • Ensure you've activated the virtual environment
    • Install dependencies: pip install -r requirements.txt
  2. "Connection refused" errors

    • Make sure both backend (port 8001) and frontend (port 5174) servers are running
    • Check that your Google Gemini API key is properly set in the .env file
    • Verify your internet connection for API access
  3. PDF processing takes too long

    • Large PDFs may take several minutes to process and create vector embeddings
    • Ensure your system has sufficient RAM (4GB+ recommended)
    • Consider splitting very large PDFs into smaller sections
  4. Flashcard/Exam generation fails

    • Ensure PDFs are uploaded and processed successfully
    • Check that your Google Gemini API key in the .env file is valid and has quota
    • Verify the topic/page range exists in your uploaded documents
    • Check the browser console for detailed error messages
  5. "GOOGLE_API_KEY environment variable not set" error

    • Make sure you have created a .env file in the backend directory
    • Add your Google Gemini API key: GOOGLE_API_KEY=your_key_here
    • Restart the backend server after adding the key
  6. "API quota exceeded" errors

    • The Google Gemini API key may have reached its usage limit
    • Wait for the quota to reset or use a different API key
    • Check your Google AI Studio dashboard for API usage statistics

Performance Tips

  • For better performance, use PDFs with clear text (avoid image-based PDFs)
  • Start with smaller page ranges (1-20 pages) when generating exams
  • Use specific topics when generating flashcards for better results
  • The sidebar navigation provides quick access to all features
  • Use the file selection in chat to focus on specific documents
  • Regular exam practice helps track learning progress over time

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test thoroughly
  5. Submit a pull request

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

If you encounter any issues or have questions, please:

  1. Check the troubleshooting section above
  2. Review the GitHub issues page
  3. Create a new issue with detailed information about your problem

Future Enhancements

  • Support for more document formats (Word, PowerPoint, EPUB)
  • Advanced analytics dashboard with learning insights
  • Spaced repetition algorithm for flashcards
  • Collaborative study groups and sharing
  • Mobile app support with offline capabilities
  • Integration with popular learning management systems (Moodle, Canvas)
  • Multi-language support for international users
  • Voice-based interactions and audio flashcards
  • AI-powered study schedule recommendations
  • Export functionality for notes and flashcards

StudyMate AI - Transform your study materials into intelligent, interactive learning experiences powered by Google Gemini AI! 🚀

Screenshots

Dashboard & Navigation

  • Modern sidebar navigation with gradient design
  • Quick access to all study tools and features
  • Responsive design for desktop and mobile

AI Chat Interface

  • Intelligent conversations about your study materials
  • File selection for focused learning sessions
  • Suggested questions to get started quickly
  • Real-time responses powered by Google Gemini

Exam Center

  • Generate custom exams from your PDFs
  • Multiple question types and difficulty levels
  • Timer functionality and instant scoring
  • Detailed performance feedback and explanations

Progress Tracking

  • Comprehensive exam history and statistics
  • Visual performance trends over time
  • Learning insights and recommendations

About

A comprehensive AI-powered study assistant that transforms your PDF study materials into interactive learning tools including flashcards, practice exams, and an intelligent chat interface powered by Google Gemini AI.

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages