# ClassMate NG — AI Study Coach
> **Transform your course materials into personalized learning experiences with AI-powered study coaching.**
A comprehensive educational platform designed specifically for Nigerian university students, helping them convert messy PDFs and course slides into structured lessons, interactive flashcards, and intelligent quizzes with WhatsApp integration for daily study reminders.
## 🎯 Project Overview
ClassMate NG is a full-stack AI-powered study platform that addresses the unique challenges faced by Nigerian university students. The platform uses advanced AI to process course materials and create personalized learning experiences.
### Key Features
- **📤 Smart Upload System**: Students and lecturers can upload PDFs, slides, or paste links
- **🎓 AI Lesson Builder**: Automatically converts materials into structured lessons with learning objectives and flashcards
- **🧠 Intelligent Quiz Generator**: Creates MCQs and short-answer questions with rationales and difficulty tags
- **📱 WhatsApp Integration**: Daily study nudges and interactive quiz questions via WhatsApp
- **📊 Analytics Dashboard**: Comprehensive tracking of topic mastery, streaks, and study time
- **👨🏫 Lecturer Portal**: Export AI-generated question banks and monitor student progress
## 🏗️ Architecture
### Frontend (Current Implementation)
- **Framework**: React 18 with TypeScript
- **Styling**: Tailwind CSS with custom design system
- **UI Components**: Shadcn/ui with custom variants
- **Routing**: React Router v6
- **State Management**: React Query for server state
- **Build Tool**: Vite
### Backend (Planned Integration)
- **API**: FastAPI with async/await
- **Database**: PostgreSQL with pgvector extension
- **AI Integration**: LLM APIs for content processing
- **Search**: RAG pipeline with embeddings
- **Real-time**: WebSocket connections
- **Deployment**: Docker containers
## 🚀 Getting Started
### Prerequisites
- Node.js 18+
- npm or yarn package manager
### Instal …