Mind Mentor: AI-Powered Study Assistant

Table of Contents

• Overview
• Features
• Tech Stack
• Installation
• API Integration
• Usage Guide
• Contributing
• License

Demo

Recording.2025-02-05.165625.mp4

Overview

Mind Mentor is an intelligent study companion that leverages AI to transform the learning experience. It combines personalized study planning, resource curation, and interactive assistance to help students achieve their academic goals efficiently.

Key Features

1. AI-Powered Study Planning 📚

• Dynamic Plan Generation
  • Subject-based customization
  • Exam date optimization
  • Weekly learning milestones
  • Daily task breakdown
• Progress Tracking
  • Visual progress indicators
  • Completion status
  • Adjustable schedules
  • Performance analytics

2. Smart Resource Curation 🔍

• AI-Driven Content Discovery
  • Tavily API integration for relevant search
  • Quality scoring algorithm
  • Content type diversity
• Resource Types Support
  • Video tutorials
  • Online courses
  • Documentation
  • Practice exercises
  • Academic papers
• Smart Filtering
  • Difficulty level categorization
  • Format-based organization
  • Topic relevance ranking

3. Interactive PDF Chat Assistant 📄

• Document Analysis
  • Upload and process PDF documents
  • AI-powered document comprehension
  • Contextual question answering
• Smart Features
  • Source page references
  • Relevant excerpt highlighting
  • Chat history persistence
  • Context-aware responses
• PDF Viewer Integration
  • Page navigation and tracking
  • Zoom and rotation controls
  • Fullscreen mode
  • Synchronized chat and document view

4. User Experience 🎯

• Modern Interface
  • Clean, responsive design
  • Toast notifications
  • Loading states
• Navigation Features
  • Pagination system

Tech Stack

Frontend

• Framework: Next.js 14 with App Router
• Language: TypeScript
• Styling:
  • Tailwind CSS for utility-first styling
  • Shadcn UI for component library
• State Management:
  • Zustand for global state
  • React Query for server state
• Authentication: NextAuth.js with JWT
• PDF Processing:
  • React-PDF for document viewing
  • PDF.js for text extraction
  • Custom chat interface

Backend

• Runtime: Node.js with Express
• Database: MongoDB with Mongoose ODM
• AI Services:
  • Groq API for study plan generation and PDF analysis
  • HuggingFace for document embeddings
  • Tavily API for resource curation
• Security:
  • JWT authentication
  • Rate limiting
  • Input validation

Installation

1. Clone the repository:

git clone https://github.com/KartikLabhshetwar/mind-mentor
cd mind-mentor

2. Set up environment variables:

Create .env file in the root directory with the following variables:

NEXTAUTH_SECRET=your-secret-key
MONGODB_URI=your-mongodb-uri
NEXTAUTH_URL=http://localhost:3000
EXPRESS_BACKEND_URL=http://backend:8000
NEXT_PUBLIC_POSTHOG_KEY=your-posthog-key
NEXT_PUBLIC_POSTHOG_HOST=your-posthog-host
NEXT_PUBLIC_API_URL=http://backend:8000
API_URL=http://backend:8000
GROQ_API_KEY=your-groq-api-key
GROQ_API_KEY_RAG=your-groq-rag-api-key
TAVILY_API_KEY=your-tavily-api-key

3. Build with Docker Compose:

docker compose build

4. Run with Docker Compose:

docker compose up -d

The application will be available at:

• Frontend: http://localhost:3000
• Backend: http://localhost:8000

API Integration

Groq API

Used for:

• Study plan generation
• Resource description enhancement
• Learning path recommendations

Tavily API

Used for:

• Educational resource curation
• Content relevance scoring
• Resource metadata extraction

Usage Guide

Study Plan Generation

1. Navigate to the study plan section
2. Enter your subject and exam date
3. Click "Generate Plan"
4. View and customize your personalized study schedule

Pomodoro Timer

1. A 25 minute timer work/break duration
2. Start your study session
3. Follow the timer prompts for breaks
4. View your session history and statistics
5. Adjust intervals based on productivity patterns

Notes Management

1. Create new notes with rich text formatting
2. Organize notes by subjects/topics
3. Use the search function to find specific content
4. Export notes in various formats
5. Access your notes across devices

PDF Chat Assistant

1. Upload your PDF document
2. Ask questions about the content
3. View source pages and relevant excerpts
4. Navigate through the document while chatting
5. Access chat history for previous conversations

Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to your branch
5. Create a Pull Request

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

---

Built with 💡 by Kartik Labhshetwar