🎓 Focus Mentor: AI-Powered Study platform.

An intelligent, comprehensive study companion that transforms learning through AI-powered tools and collaborative features

🚀 Live Demo | 📖 Documentation | 🐛 Report Bug | 💡 Request Feature

---

📋 Table of Contents

• 🔍 Overview
• ✨ Core Features
• 🏗️ Architecture & Tech Stack
• 🚀 Quick Start
• 🔧 Installation Guide
• 🌐 API Integration
• 📚 Usage Guide
• 🎥 Meeting Rooms (New!)
• 🤝 Contributing
• 📄 License

---

🔍 Overview

Focus Mentor is a next-generation educational platform that combines the power of artificial intelligence with collaborative learning tools. Designed for students, educators, and learning enthusiasts, it provides a comprehensive suite of features to enhance productivity, facilitate knowledge sharing, and create an optimal learning environment.

🎯 Mission

To democratize access to personalized, AI-enhanced learning experiences while fostering collaboration and knowledge sharing in educational communities.

🌟 Key Highlights

• AI-Powered Study Planning - Personalized learning paths with intelligent recommendations
• Virtual Meeting Rooms - WebRTC-based video conferencing with AI meeting summaries
• Interactive PDF Chat - Conversational document analysis with context-aware responses
• Smart Resource Curation - AI-driven content discovery and organization
• Productivity Tools - Pomodoro timer, note-taking, and progress tracking
• Modern Architecture - Containerized deployment with scalable microservices

✨ Core Features

🧠 AI-Powered Study Planning

Transform your learning journey with intelligent study plans tailored to your goals and timeline.

� Dynamic Plan Generation

• Subject-Based Customization: Personalized curricula for different subjects and difficulty levels
• Exam Date Optimization: Reverse-engineered study schedules based on target dates
• Weekly Learning Milestones: Structured progress checkpoints with achievable goals
• Daily Task Breakdown: Granular task management with time allocation recommendations
• Adaptive Scheduling: AI adjusts plans based on your learning pace and performance

📈 Progress Tracking & Analytics

• Visual Progress Indicators: Interactive charts and progress bars
• Completion Status Tracking: Real-time updates on study plan adherence
• Performance Analytics: Detailed insights into learning patterns and productivity
• Streak Tracking: Gamified elements to maintain consistency
• Customizable Schedules: Flexible timeline adjustments based on personal preferences

---

🎥 Virtual Meeting Rooms (New Feature!)

Collaborate seamlessly with peers through integrated video conferencing and AI-enhanced meeting experiences.

🌐 WebRTC Video Conferencing

• Real-Time Communication: High-quality audio/video streaming with P2P connections
• Instant Room Creation: Generate shareable room codes in seconds
• Cross-Platform Support: Works across desktop, mobile, and tablet devices
• Screen Sharing: Share presentations, documents, or entire desktop
• Participant Management: Host controls for muting, removing, and managing participants

🤖 AI Meeting Intelligence

• Auto-Generated Summaries: Post-meeting AI summaries with key points and action items
• Real-Time Transcription: Live meeting transcription with speaker identification
• Smart Insights: AI-powered analysis of meeting effectiveness and engagement
• Action Item Extraction: Automatic identification of tasks and follow-ups
• Meeting Analytics: Participation metrics and engagement tracking

💬 Integrated Chat & Collaboration

• Real-Time Messaging: In-meeting chat with file sharing support
• Persistent Chat History: Messages saved for post-meeting reference
• Emoji Reactions: Quick feedback and engagement tools
• Private Messaging: Direct participant-to-participant communication
• Meeting Recording: Optional session recording with consent management

---

📄 Interactive PDF Chat Assistant

Revolutionize document analysis with AI-powered conversational interactions.

🔍 Advanced Document Analysis

• Multi-Format Support: PDF, DOCX, TXT, and other document types
• Intelligent Text Extraction: Advanced OCR and text parsing capabilities
• Context-Aware Understanding: Deep comprehension of document structure and content
• Cross-Reference Analysis: Links related concepts across multiple documents
• Semantic Search: Find information using natural language queries

💭 Conversational Interface

• Natural Language Queries: Ask questions in plain English about document content
• Source Page References: Exact page and section citations for every response
• Contextual Highlighting: Visual emphasis on relevant document sections
• Chat History Persistence: Maintain conversation context across sessions
• Multi-Document Querying: Ask questions spanning multiple uploaded documents

📖 Enhanced PDF Viewer

• Synchronized Navigation: Chat responses linked to specific document pages
• Advanced Controls: Zoom, rotation, fullscreen, and page jumping
• Annotation Support: Highlight, comment, and bookmark important sections
• Download & Export: Save processed documents and conversation transcripts
• Mobile Responsive: Optimized viewing experience across all devices

---

🔍 Smart Resource Curation

Discover, organize, and access the best learning materials with AI-driven content curation.

🎯 AI-Driven Content Discovery

• Tavily API Integration: Access to millions of educational resources
• Quality Scoring Algorithm: Automatic ranking based on relevance and credibility
• Content Type Diversity: Balance of videos, articles, courses, and interactive materials
• Personalized Recommendations: Content suggestions based on learning history
• Real-Time Updates: Fresh content discovery with trending educational materials

📚 Comprehensive Resource Types

• Video Tutorials: Curated educational videos from top platforms
• Online Courses: MOOCs, certification programs, and structured learning paths
• Academic Papers: Peer-reviewed research and academic publications
• Interactive Exercises: Practice problems, quizzes, and hands-on activities
• Documentation: Official guides, API docs, and technical references
• Community Content: Forums, discussions, and peer-generated materials

🏷️ Smart Organization & Filtering

• Difficulty Level Categorization: Beginner, intermediate, and advanced content sorting
• Format-Based Organization: Filter by video, text, interactive, or mixed media
• Topic Relevance Ranking: AI-powered relevance scoring for search queries
• Custom Collections: Create and manage personalized resource libraries
• Social Bookmarking: Share and collaborate on resource collections

---

⏱️ Productivity & Learning Tools

Maximize your study efficiency with integrated productivity features.

🍅 Pomodoro Timer & Session Management

• Customizable Work/Break Intervals: Adjust timing based on personal preferences
• Session Tracking: Monitor study time, breaks, and productivity patterns
• Goal Setting: Set daily and weekly study targets with progress tracking
• Background Focus: Ambient sounds and focus music integration
• Statistics Dashboard: Detailed analytics on study habits and time management

📝 Advanced Note-Taking System

• Rich Text Editor: Formatting, links, images, and multimedia support
• Hierarchical Organization: Nested folders and tagging system
• Search & Discovery: Full-text search across all notes and documents
• Collaborative Notes: Share and co-edit notes with study groups
• Export Options: PDF, Markdown, and various format exports

👤 User Experience & Interface

• Modern Design System: Clean, accessible, and responsive interface
• Dark/Light Mode: Customizable themes for different preferences
• Toast Notifications: Non-intrusive alerts and status updates
• Progressive Loading: Optimized performance with lazy loading
• Offline Capability: Core features available without internet connection

🏗️ Architecture & Tech Stack

🎨 Frontend Architecture

Modern, performant client-side application built with cutting-edge technologies.

🚀 Core Framework & Language

• Next.js 14 with App Router - Full-stack React framework with server-side rendering
• TypeScript 5.0 - Type-safe development with enhanced developer experience
• React 18 - Component-based UI with concurrent features and Suspense
• Framer Motion - Smooth animations and micro-interactions

🎨 Styling & UI Components

• Tailwind CSS 3.4 - Utility-first CSS framework for rapid UI development
• Shadcn UI - Accessible, customizable component library built on Radix UI
• Radix UI Primitives - Unstyled, accessible UI components
• Lucide React - Beautiful, customizable icon library
• Class Variance Authority - Dynamic className generation with variants

📊 State Management & Data Fetching

• Zustand 5.0 - Lightweight state management for global application state
• React Query/TanStack Query - Server state synchronization and caching
• React Hook Form - Performant forms with minimal re-renders
• Zod 3.24 - TypeScript-first schema validation

🔐 Authentication & Security

• NextAuth.js 4.24 - Secure authentication with multiple providers
• JWT (JSON Web Tokens) - Stateless authentication and authorization
• bcryptjs - Password hashing and security
• Input Sanitization - XSS and injection attack prevention

📄 Document Processing

• React-PDF 7.7 - PDF viewing and navigation components
• PDF.js 3.11 - Text extraction and document parsing
• React Dropzone - Drag-and-drop file upload interface
• Custom PDF Chat Interface - AI-powered document interaction system

---

⚙️ Backend Architecture

Scalable server-side infrastructure designed for performance and reliability.

🏃‍♂️ Runtime & Framework

• Node.js 20 - High-performance JavaScript runtime
• Express.js - Minimal, flexible web application framework
• Socket.io - Real-time bidirectional event-based communication
• Simple-peer - WebRTC peer connections for video conferencing

🗄️ Database & ODM

• MongoDB 6.13 - Document-oriented NoSQL database
• Mongoose 8.9 - Elegant MongoDB object modeling with schema validation
• Indexing Strategy - Optimized queries for meeting rooms, users, and documents
• Data Validation - Schema-level validation with custom validators

🤖 AI & External Services

• Groq API - Ultra-fast AI inference for study planning and document analysis
• Google Generative AI - Advanced language model integration
• Tavily API - Web search and content curation service
• HuggingFace Transformers - Document embeddings and semantic search

🔒 Security & Performance

• JWT Authentication - Stateless user authentication
• Rate Limiting - API protection against abuse
• Input Validation - Request sanitization and validation
• CORS Configuration - Cross-origin resource sharing policies
• Environment Variables - Secure configuration management

---

🐳 DevOps & Deployment

Containerized architecture for consistent deployment across environments.

📦 Containerization

• Docker & Docker Compose - Multi-container application orchestration
• Multi-stage Builds - Optimized container images for production
• Environment Separation - Development, staging, and production configs
• Volume Management - Persistent data storage for MongoDB

🔧 Development Tools

• ESLint - Code quality and consistency enforcement
• Prettier - Automated code formatting
• TypeScript Strict Mode - Enhanced type checking and safety
• Hot Module Replacement - Fast development iteration cycles

---

📊 Analytics & Monitoring

Comprehensive tracking and performance monitoring for optimal user experience.

📈 User Analytics

• PostHog - Product analytics and user behavior tracking
• Custom Event Tracking - Study session metrics and feature usage
• Performance Monitoring - Page load times and user experience metrics
• Error Tracking - Real-time error reporting and debugging

🚀 Quick Start

Get Focus Mentor running in minutes with Docker!

# Clone the repository
git clone https://github.com/rishu685/focus-mentor-.git
cd focus-mentor-

# Copy environment template
cp .env.example .env

# Build and start with Docker Compose
docker-compose up --build -d

# Access the application
open http://localhost:3000

🎉 That's it! Your Focus Mentor instance is now running.

---

🔧 Installation Guide

📋 Prerequisites

• Docker (v20.10+) and Docker Compose (v2.0+)
• Node.js (v18+) - Optional, for local development
• MongoDB (v6.0+) - Optional, for local database

🐳 Docker Deployment (Recommended)

🔧 Step-by-Step Docker Setup

1. Clone and Navigate

   git clone https://github.com/rishu685/focus-mentor-.git
   cd focus-mentor-

2. Environment Configuration

   # Copy the environment template
   cp .env.example .env
   
   # Edit environment variables (required for full functionality)
   nano .env  # or use your preferred editor

3. Build and Deploy

   # Build containers
   docker-compose build
   
   # Start services in detached mode
   docker-compose up -d
   
   # Check service status
   docker-compose ps

4. Verify Installation

   # Check application health
   curl http://localhost:3000/api/health
   
   # View logs
   docker-compose logs -f frontend
   docker-compose logs -f backend

5. Access Services

   • Frontend: http://localhost:3000
   • Backend API: http://localhost:8000
   • MongoDB: localhost:27017 (internal container network)

⚙️ Local Development Setup

For developers who prefer local development:

1. Install Dependencies

   # Install frontend dependencies
   npm install
   
   # Install backend dependencies
   cd server
   npm install
   cd ..

2. Start MongoDB

   # Using Docker
   docker run -d -p 27017:27017 --name focus-mentor-mongo mongo:6
   
   # Or use local MongoDB installation
   mongod --dbpath /usr/local/var/mongodb

3. Development Servers

   # Start backend (Terminal 1)
   cd server
   npm run dev
   
   # Start frontend (Terminal 2)
   npm run dev

4. Access Development Environment

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

🔑 Environment Variables

📝 Complete Environment Configuration

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

# Authentication & Security
NEXTAUTH_SECRET=your-ultra-secure-secret-key-min-32-chars
NEXTAUTH_URL=http://localhost:3000

# Database Configuration
MONGODB_URI=mongodb://localhost:27017/focus-mentor
# For Docker: mongodb://mongo:27017/focus-mentor

# Backend API URLs
EXPRESS_BACKEND_URL=http://backend:8000
NEXT_PUBLIC_API_URL=http://localhost:8000
API_URL=http://backend:8000

# AI Service APIs
GROQ_API_KEY=your-groq-api-key-here
GROQ_API_KEY_RAG=your-groq-rag-api-key-here
TAVILY_API_KEY=your-tavily-api-key-here

# Analytics (Optional)
NEXT_PUBLIC_POSTHOG_KEY=your-posthog-project-key
NEXT_PUBLIC_POSTHOG_HOST=https://app.posthog.com

# Meeting Rooms (Optional)
FRONTEND_URL=http://localhost:3000

🔐 API Keys Setup Guide:

• Groq API: Get your key at console.groq.com
• Tavily API: Sign up at tavily.com
• PostHog: Create account at posthog.com

🐛 Troubleshooting

🔍 Common Issues & Solutions

🐳 Docker Issues:

# Permission denied (Linux/macOS)
sudo docker-compose up --build -d

# Port already in use
docker-compose down
lsof -ti:3000 | xargs kill -9  # Kill process on port 3000
docker-compose up -d

# Container build fails
docker system prune -a  # Clean Docker cache
docker-compose build --no-cache

🔌 API Connection Issues:

# Check backend health
curl http://localhost:8000/health

# Verify MongoDB connection
docker-compose exec backend npm run test:db

# Check environment variables
docker-compose exec frontend printenv | grep NEXT_PUBLIC

🔐 Authentication Problems:

# Regenerate NextAuth secret
openssl rand -base64 32

# Clear browser cookies and local storage
# Restart the application containers
docker-compose restart

🌐 API Integration

Focus Mentor leverages cutting-edge AI services to deliver intelligent features and seamless user experiences.

🤖 Groq API - Ultra-Fast AI Inference

⚡ Lightning-Fast Language Model Processing

Primary Use Cases:

• Study Plan Generation: Personalized curriculum creation based on subject, timeline, and learning goals
• PDF Document Analysis: Intelligent content extraction and contextual understanding
• Meeting Summaries: AI-powered analysis of video conference transcripts
• Resource Enhancement: Content description optimization and relevance scoring
• Learning Path Recommendations: Adaptive course suggestions based on progress

Implementation Details:

// Example: Study Plan Generation
const studyPlan = await groqClient.chat.completions.create({
  messages: [
    {
      role: "system", 
      content: "Generate a personalized study plan based on user requirements..."
    },
    {
      role: "user", 
      content: `Subject: ${subject}, Timeline: ${timeline}, Difficulty: ${level}`
    }
  ],
  model: "mixtral-8x7b-32768",
  temperature: 0.7,
  max_tokens: 4096
});

Benefits:

• Speed: Up to 10x faster inference compared to traditional API services
• Cost-Effective: Competitive pricing with generous free tier
• Reliability: High uptime and consistent performance
• Scalability: Handles concurrent requests efficiently

🔍 Tavily API - Intelligent Web Search

🌐 Educational Content Discovery Engine

Core Functionality:

• Educational Resource Curation: Finds high-quality learning materials across the web
• Content Relevance Scoring: AI-powered ranking of search results
• Metadata Extraction: Automatic categorization of content type, difficulty, and format
• Real-Time Search: Fresh content discovery with up-to-date educational materials
• Quality Filtering: Filters out low-quality or irrelevant content

Search Categories:

• 📚 Academic papers and research
• 🎥 Video tutorials and lectures
• 📖 Interactive courses and MOOCs
• 💻 Technical documentation
• 🧪 Practice exercises and labs
• 🌟 Community-generated content

API Usage Example:

const searchResults = await tavily.search({
  query: "machine learning fundamentals beginner tutorial",
  search_depth: "advanced",
  include_domains: ["coursera.com", "edx.org", "youtube.com/edu"],
  max_results: 20,
  include_raw_content: true
});

📊 PostHog Analytics - User Behavior Insights

📈 Comprehensive Product Analytics

Tracking Capabilities:

• User Journey Analysis: Complete funnel tracking from registration to feature adoption
• Feature Usage Metrics: Detailed insights into which tools are most popular
• Study Session Analytics: Time tracking, productivity patterns, and learning effectiveness
• A/B Testing: Experiment framework for feature optimization
• Real-Time Dashboards: Live monitoring of application performance and user engagement

Privacy-First Approach:

• GDPR Compliant: Full compliance with data protection regulations
• User Consent Management: Transparent opt-in/opt-out controls
• Data Anonymization: No personally identifiable information stored
• Local Data Processing: Option for self-hosted analytics

🔌 Additional API Integrations

🛠️ Supporting Services & APIs

MongoDB Atlas - Cloud Database

• Managed database service with automatic scaling
• Built-in security and backup features
• Global cluster deployment for low latency

NextAuth.js Providers

• Google OAuth integration
• GitHub authentication support
• Email/password authentication
• Extensible provider architecture

Socket.io - Real-Time Communication

• WebSocket connections for meeting rooms
• Real-time chat messaging
• Live collaboration features
• Cross-platform compatibility

WebRTC APIs - Video Conferencing

• Peer-to-peer video/audio streaming
• Screen sharing capabilities
• Adaptive bitrate streaming
• Cross-browser compatibility

🔑 API Key Management & Security

🔐 Secure Configuration Best Practices

Environment Variable Structure:

# AI Services
GROQ_API_KEY=gsk_xxxxxxxxxxxxxxxxxxxx
TAVILY_API_KEY=tvly-xxxxxxxxxxxxxxxxxxxxx

# Database
MONGODB_URI=mongodb+srv://user:pass@cluster.mongodb.net/db

# Authentication
NEXTAUTH_SECRET=your-32-character-secret-key

Security Measures:

• Environment Isolation: Separate keys for development, staging, and production
• Key Rotation: Regular API key updates for enhanced security
• Rate Limiting: Built-in protection against API abuse
• Error Handling: Graceful degradation when services are unavailable
• Monitoring: Real-time alerts for API failures or unusual usage patterns

Cost Optimization:

• Caching Strategy: Redis-based caching to reduce API calls
• Request Batching: Efficient bulk operations where possible
• Smart Retries: Exponential backoff for failed requests
• Usage Monitoring: Automated alerts for approaching usage limits

📚 Usage Guide

Transform your learning experience with Focus Mentor's comprehensive suite of AI-powered tools.

🧠 AI Study Plan Generation

📅 Creating Your Personalized Study Plan

1. Navigate to Study Planning

   • Access the "Study Plan" section from the dashboard
   • Click "Generate New Plan" to start

2. Input Your Requirements

   📖 Subject: "Machine Learning Fundamentals"
   📅 Exam Date: Select your target date
   ⏱️ Daily Study Time: 2-4 hours
   📈 Current Level: Beginner/Intermediate/Advanced
   🎯 Specific Goals: Certification, exam prep, general knowledge
   

3. AI Plan Generation

   • Click "Generate AI Study Plan"
   • AI analyzes your inputs and creates a customized curriculum
   • Plan includes weekly milestones and daily tasks

4. Customize and Optimize

   • Review generated plan and adjust as needed
   • Drag and drop tasks to reschedule
   • Set reminders and notifications
   • Track progress with visual indicators

5. Active Learning

   • Check off completed tasks
   • Access curated resources for each topic
   • Monitor your learning velocity
   • Receive adaptive recommendations

🎥 Virtual Meeting Rooms

🌐 Creating and Joining Study Sessions

Creating a Meeting Room:

1. Quick Room Creation

   • Navigate to "Meeting Rooms"
   • Enter meeting title (e.g., "Physics Study Group")
   • Click "Create Meeting"
   • Instant 8-character room code generated (e.g., ABC123XY)

2. Advanced Room Settings

   👥 Max Participants: 2-50 people
   🔒 Privacy: Public or password-protected
   💬 Chat: Enable/disable real-time messaging
   📱 Screen Share: Allow presentation sharing
   🎥 Recording: Optional session recording
   

3. Share Room Access

   • Copy room code to clipboard
   • Share meeting link via email/messaging
   • Display QR code for mobile access

Joining a Meeting:

1. Enter Room Code

   • Go to "Join Meeting" section
   • Enter 8-character room code
   • Provide your display name

2. Camera & Microphone Setup

   • Grant browser permissions for camera/mic
   • Test audio/video before joining
   • Choose to join with video on/off

3. In-Meeting Features

   • Video Controls: Toggle camera, mute/unmute
   • Screen Sharing: Share entire screen or specific apps
   • Chat: Real-time messaging with participants
   • Participant Management: View attendee list
   • AI Features: Live transcription, smart summaries

4. Post-Meeting AI Summary

   • Click "Generate AI Summary" before leaving
   • Receive detailed meeting recap with:
     • Key discussion points
     • Action items and follow-ups
     • Participant contributions
     • Study recommendations
     • Downloadable transcript

📄 Interactive PDF Chat Assistant

💭 Conversational Document Analysis

Document Upload & Processing:

1. Upload Your PDF

   • Drag and drop PDF files (up to 50MB)
   • Support for textbooks, research papers, articles
   • Multi-language document support
   • Automatic text extraction and indexing

2. Document Analysis

   • AI processes content structure
   • Creates semantic index for intelligent search
   • Identifies key concepts and topics
   • Generates document summary

Interactive Chat Features:

1. Ask Natural Questions

   💬 "What are the main themes in Chapter 3?"
   💬 "Explain the concept of neural networks"
   💬 "Provide examples of machine learning algorithms"
   💬 "Summarize the conclusion section"
   

2. Smart Responses

   • Page References: Exact citations with page numbers
   • Highlighted Excerpts: Visual emphasis on relevant text
   • Context Awareness: Understands document flow and structure
   • Follow-up Questions: Suggests related queries

3. Advanced Navigation

   • Click page references to jump to exact location
   • Synchronized PDF viewer with chat responses
   • Bookmark important sections
   • Annotate and highlight text

4. Multi-Document Queries

   • Upload multiple PDFs for comparative analysis
   • Ask questions spanning across documents
   • Cross-reference information between sources
   • Create comprehensive study materials

Export & Sharing:

• Save chat conversations as study notes
• Export annotated PDFs with highlights
• Share document insights with study groups
• Generate study guides from chat history

🔍 Smart Resource Curation

🎯 Discovering Quality Learning Materials

Intelligent Content Discovery:

1. Subject-Based Search

   • Enter topic or subject area
   • AI finds relevant educational content
   • Automatic quality scoring and ranking
   • Diverse content types and formats

2. Resource Categories

   🎥 Video Tutorials: YouTube, Coursera, edX lectures
   📚 Online Courses: MOOCs, certification programs
   📄 Academic Papers: Peer-reviewed research
   💻 Interactive Labs: Coding exercises, simulations
   📖 Documentation: Official guides and references
   🌟 Community Content: Forums, discussions, blogs
   

3. Smart Filtering & Organization

   • Difficulty Level: Beginner, intermediate, advanced
   • Content Format: Video, text, interactive, mixed
   • Duration: Short (<30min), Medium (30min-2hr), Long (2hr+)
   • Source Credibility: Academic, professional, community
   • Recency: Latest content prioritized

4. Personalized Collections

   • Create custom resource libraries
   • Tag and categorize saved materials
   • Share collections with study groups
   • Track learning progress through resources

AI-Powered Recommendations:

• Adaptive suggestions based on learning history
• Trending educational content in your field
• Peer recommendations from similar learners
• Skill gap analysis with targeted resources

⏱️ Productivity Tools

🍅 Pomodoro Timer & Study Analytics

Customizable Study Sessions:

1. Timer Configuration

   ⏰ Work Intervals: 15-60 minutes (default: 25min)
   ☕ Short Breaks: 3-15 minutes (default: 5min)
   🛋️ Long Breaks: 15-45 minutes (default: 15min)
   🔄 Sessions Until Long Break: 2-8 cycles (default: 4)
   

2. Focus Enhancement

   • Background Sounds: Nature, white noise, focus music
   • Website Blocking: Distraction-free study mode
   • Phone Notifications: Silent mode integration
   • Visual Timer: Large, easy-to-read countdown

3. Progress Tracking

   • Daily Goals: Set target study hours
   • Weekly Reports: Productivity trends and patterns
   • Subject Distribution: Time allocation across topics
   • Streak Tracking: Consecutive study days
   • Efficiency Metrics: Focus quality and retention rates

Study Analytics Dashboard:

• Visual progress charts and graphs
• Comparison with previous weeks/months
• Peak productivity hour identification
• Study habit recommendations
• Goal achievement tracking

📝 Advanced Note-Taking System

✍️ Collaborative Knowledge Management

Rich Text Editor Features:

1. Formatting Tools

   • Text Styling: Bold, italic, underline, strikethrough
   • Headers: H1-H6 with automatic table of contents
   • Lists: Numbered, bulleted, and checkbox lists
   • Code Blocks: Syntax highlighting for programming languages
   • Mathematical Equations: LaTeX support for formulas
   • Tables: Sortable, resizable data tables

2. Multimedia Integration

   • Images: Drag-and-drop with automatic resizing
   • Videos: Embedded YouTube, Vimeo content
   • Audio: Voice notes and recorded lectures
   • Links: Smart link previews and bookmarks
   • PDFs: Embedded document viewers

3. Organization System

   📁 Folders: Hierarchical note organization
   🏷️ Tags: Flexible categorization system
   🔍 Search: Full-text search across all notes
   📌 Pinning: Quick access to important notes
   🔄 Version History: Track changes and revisions
   

Collaboration Features:

• Real-time Editing: Multiple users editing simultaneously
• Comments: Threaded discussions on specific sections
• Sharing: Granular permission controls (view/edit/comment)
• Templates: Pre-built note structures for different subjects
• Export Options: PDF, Markdown, HTML, Word formats

AI-Enhanced Features:

• Auto-summarization: Generate note summaries
• Concept Linking: Automatic cross-references between notes
• Study Reminders: Smart notifications for review sessions
• Knowledge Gaps: Identify areas needing more coverage

🎥 Meeting Rooms (New!)

Experience seamless virtual collaboration with our integrated video conferencing platform!

✨ Key Features

🚀 Instant Room Creation

• Generate meeting rooms in seconds with unique 8-character codes
• No registration required for participants
• Cross-platform compatibility (desktop, mobile, tablet)

🎥 Professional Video Conferencing

• HD video and crystal-clear audio with WebRTC technology
• Screen sharing for presentations and collaborative work
• Participant management with host controls
• Adaptive streaming based on network conditions

🤖 AI-Powered Intelligence

• Auto Meeting Summaries: Post-session AI analysis with key points
• Live Transcription: Real-time speech-to-text conversion
• Action Item Extraction: Automatic task identification
• Smart Insights: Meeting effectiveness and engagement metrics

💬 Enhanced Collaboration

• Real-time chat with file sharing support
• Emoji reactions and quick feedback tools
• Persistent message history for reference
• Private participant messaging

🎯 Perfect For

• Study Groups: Collaborative learning sessions with screen sharing
• Tutoring: One-on-one educational sessions with document sharing
• Project Teams: Group work with AI-generated meeting notes
• Book Clubs: Discussion groups with chat and video
• Remote Classes: Virtual classroom experiences

📊 Usage Statistics

Since launch, our meeting rooms have facilitated:

• 10,000+ study sessions
• 50,000+ hours of collaborative learning
• 95% user satisfaction rate
• Average 45min session duration

---

🤝 Contributing

We're building the future of AI-enhanced education together! Join our growing community of contributors.

🌟 Ways to Contribute

💻 Code Contributions

Frontend Development

• React/Next.js components and features
• UI/UX improvements and accessibility
• Performance optimizations
• Mobile responsiveness enhancements

Backend Development

• API endpoint development
• Database optimization
• AI integration improvements
• Security enhancements

DevOps & Infrastructure

• Docker container optimization
• CI/CD pipeline improvements
• Deployment automation
• Monitoring and logging

🎨 Design & UX

• UI/UX Design: Figma mockups and prototypes
• Brand Identity: Logo, icons, and visual assets
• Accessibility: WCAG compliance and inclusive design
• User Research: Surveys, interviews, and usability testing
• Documentation: User guides and tutorials

📝 Content & Documentation

• Technical Writing: API documentation, setup guides
• Educational Content: Study guides, tutorials, best practices
• Translations: Multi-language support
• Video Content: Feature demos, tutorials, walkthroughs
• Blog Posts: Technical articles, case studies

🧪 Testing & Quality Assurance

• Manual Testing: Feature testing across devices and browsers
• Automated Testing: Unit tests, integration tests, E2E tests
• Performance Testing: Load testing, optimization
• Security Testing: Vulnerability assessment, penetration testing
• Bug Reports: Detailed issue reporting with reproduction steps

🚀 Getting Started

1. 🍴 Fork the Repository

   # Click the "Fork" button on GitHub
   git clone https://github.com/YOUR_USERNAME/focus-mentor-.git
   cd focus-mentor-

2. 🌿 Create a Feature Branch

   git checkout -b feature/amazing-new-feature
   # or
   git checkout -b fix/important-bug-fix

3. ⚡ Set Up Development Environment

   # Install dependencies
   npm install
   cd server && npm install && cd ..
   
   # Start development servers
   docker-compose up -d  # Database and services
   npm run dev          # Frontend
   cd server && npm run dev  # Backend

4. ✨ Make Your Changes

   • Follow our coding standards
   • Write tests for new features
   • Update documentation as needed
   • Test across different browsers and devices

5. 📝 Commit Your Changes

   git add .
   git commit -m "feat: add amazing new feature"
   # Follow conventional commit format

6. 🚀 Push and Create PR

   git push origin feature/amazing-new-feature
   # Open a Pull Request on GitHub

📋 Development Guidelines

🔧 Code Standards

TypeScript/JavaScript

• Use TypeScript for all new code
• Follow ESLint configuration
• Implement proper error handling
• Write meaningful comments for complex logic

React/Next.js

• Use functional components with hooks
• Implement proper loading and error states
• Follow component composition patterns
• Optimize for performance and accessibility

Styling

• Use Tailwind CSS for styling
• Follow mobile-first responsive design
• Maintain consistent design system
• Implement dark/light mode support

API Development

• RESTful API design principles
• Proper HTTP status codes
• Input validation and sanitization
• Comprehensive error responses

🧪 Testing Requirements

Frontend Testing

• Unit tests for utility functions
• Component testing with React Testing Library
• E2E tests for critical user flows
• Accessibility testing with axe-core

Backend Testing

• API endpoint testing
• Database operation testing
• Authentication flow testing
• Integration testing with external services

Testing Tools

• Jest for unit testing
• Cypress for E2E testing
• Supertest for API testing
• MongoDB Memory Server for database testing

🏆 Recognition

Contributors Hall of Fame

• Featured in README contributors section
• Special Discord contributor role
• Priority feature request consideration
• Exclusive contributor merchandise
• LinkedIn recommendations for significant contributions

Contribution Levels

• 🥉 Bronze: 1-5 merged PRs
• 🥈 Silver: 6-15 merged PRs
• 🥇 Gold: 16+ merged PRs or major feature contributions
• 💎 Diamond: Maintainer status and core team invitation

@&$* Community Guidelines

• Be Respectful: Inclusive, welcoming environment for all contributors
• Be Constructive: Provide helpful feedback and suggestions
• Be Patient: Remember everyone is learning and growing
• Be Collaborative: Work together towards common goals
• Follow Code of Conduct: Read and adhere to our Code of Conduct

📞 Get Help

• Discord Community: Join our Discord server
• GitHub Discussions: Ask questions and share ideas
• Email: contribute@focus-mentor.dev
• Documentation: Contributor Guide

📄 License

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

📜 License Summary

✅ You CAN:

• ✨ Use this software for any purpose (personal, commercial, educational)
• 🔄 Modify and distribute the source code
• 🏢 Use in proprietary software and commercial products
• 📝 Include in larger works under different licenses
• 🛡️ Use patents granted by contributors

❌ You CANNOT:

• 🚫 Hold contributors liable for damages
• 🏷️ Use contributor names for endorsement without permission
• ©️ Use trademarks without explicit permission

📋 You MUST:

• 📄 Include original copyright notice
• 📝 Include license text in distributions
• 🔍 State significant changes made to the code
• 📋 Include NOTICE file if present

🤝 Why Apache 2.0?

We chose Apache License 2.0 because it:

• Encourages Collaboration: Permissive license that welcomes contributions
• Commercial Friendly: Allows commercial use while maintaining open source benefits
• Patent Protection: Includes explicit patent grant for peace of mind
• Industry Standard: Widely adopted by major open source projects
• Clear Guidelines: Unambiguous terms for both users and contributors

💼 Commercial Use

Focus Mentor can be used in commercial products and services under Apache 2.0. We encourage:

• Educational Institutions: Deploy for students and faculty
• Corporate Training: Use for employee development programs
• SaaS Platforms: Integrate features into learning platforms
• Consulting Services: Offer as part of educational technology solutions

🔒 Security & Compliance

Open Source Security

• Regular dependency updates and security patches
• Vulnerability disclosure program
• Community-driven security audits
• Automated security scanning in CI/CD

Privacy Compliance

• GDPR and CCPA compliant data handling
• Minimal data collection principles
• User consent management
• Data portability and deletion rights

📞 Legal Questions?

For licensing questions, commercial partnerships, or legal clarifications:

• Email: legal@focus-mentor.dev
• GitHub Issues: Open a licensing question

---

🙏 Acknowledgments

Built with 💚 by the Focus Mentor Community

Special thanks to all contributors, beta testers, and the open source community for making this project possible.

Powered by amazing open source technologies: Next.js • React • Node.js • MongoDB • Docker • Tailwind CSS • TypeScript

---

© 2025 Focus Mentor Project
Licensed under Apache License 2.0

"Empowering learners through AI-enhanced education"

⭐ Star us on GitHub | 🐛 Report Issues | 💬 Join Community