Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🤖 EduAI — AI-Powered Interactive Pedagogical Platform

Practice-First Intelligent Tutoring Platform with Real-Time Assessment, Socratic Mentorship & Pedagogical Analytics

Live Demo FastAPI Gemini API PWA Ready License: MIT


📌 Executive Summary

Traditional online learning platforms rely heavily on passive video lectures and manual grading queues. EduAI flips this paradigm into an active, interactive learning loop:

  • For Students: Instant diagnostic scoring, mistake breakdown, and 24/7 Socratic AI mentor that explains why an answer is right or wrong.
  • For Teachers: Automated rubric-based homework grading, class difficulty heatmaps, and customizable assignment generation.

🌟 Key Features

Feature Description
🎯 Automated AI Assessment Evaluates open-ended student answers against structured rubrics, assigning objective scores (0-100) and step-by-step diagnostic feedback.
🧠 Socratic AI Mentor Contextual chatbot that guides learners through hints and analogies rather than giving direct answers.
📊 Competency Tracker Visual skill progression bars across key curriculum domains (Logic, Syntax, Algorithms).
📱 Progressive Web App (PWA) Lightweight, installable on mobile/desktop, with offline caching support via Service Workers.
🔐 Role-Based Workspaces Dedicated interfaces and workflows for both students and instructors.

🛠️ System Architecture

┌─────────────────────────────────────────────────────────────┐
│                 Client Layer (PWA / SPA)                    │
│  - Responsive UI (HTML5, Tailwind CSS, Vanilla JavaScript) │
│  - Service Worker Offline Cache + Local Storage Sync        │
└──────────────────────────────┬──────────────────────────────┘
                               │ (HTTPS / JSON / JWT)
                               ▼
┌─────────────────────────────────────────────────────────────┐
│                 FastAPI Async Backend API                   │
│  ├── /api/auth          → JWT Token Authentication          │
│  ├── /api/assignments   → Assignment Management & Rubrics   │
│  ├── /api/submissions   → Student Submissions & History     │
│  ├── /api/ai/evaluate   → Automated Rubric Grading Engine   │
│  └── /api/ai/mentor     → Socratic Mentor Chat Session      │
└──────────────────────┬──────────────────────┬───────────────┘
                       │                      │
                       ▼                      ▼
┌───────────────────────────────┐   ┌─────────────────────────┐
│     PostgreSQL Database       │   │    Google Gemini API    │
│  - Users (Teacher / Student)  │   │  (gemini-1.5-flash)     │
│  - Assignments & Rubrics      │   │  - Structured JSON Mode │
│  - Submissions & Evaluations  │   │  - Socratic Prompts     │
└───────────────────────────────┘   └─────────────────────────┘

📂 Project Structure

eduai/
├── public/                     # Frontend Progressive Web App
│   ├── index.html              # Main single-page application
│   ├── manifest.json           # PWA web manifest
│   ├── sw.js                   # Service worker cache strategy
│   ├── css/custom.css          # Design system & dark mode
│   └── js/
│       ├── app.js              # Router & view controller
│       ├── data.js             # Local state & curriculum store
│       └── gemini.js           # Gemini API client integration
├── ARCHITECTURE.md             # Detailed engineering specifications
├── PROMPTS.md                  # Complete AI system prompts library
├── ROADMAP.md                  # Milestone development roadmap
├── vercel.json                 # Vercel deployment configuration
└── README.md                   # Project documentation

🚀 Quick Start Guide

1. Run Frontend Locally

# Option A: Python simple server
cd public
python -m http.server 3000

# Option B: Node serve
npx serve public -p 3000

Open http://localhost:3000 in your browser.

2. Configure Gemini AI API Key

  1. Get a free API key at Google AI Studio.
  2. Click "Settings / API Key" in the EduAI navigation bar.
  3. Paste your key to activate real-time AI evaluation and Socratic mentorship.

📖 Documentation & Guides

  • 🤖 PROMPTS.md — Production-grade AI system prompts for evaluation and tutoring.
  • 📐 ARCHITECTURE.md — In-depth database schema, API contracts, and security specs.
  • 🗺️ ROADMAP.md — Phased milestones and upcoming features.

👨‍💻 Author

Naimjon Inomjonov
Python Backend & AI Automation Developer


📄 License

This project is licensed under the MIT License.

About

EduAI - AI-Powered Interactive Pedagogical Platform (FastAPI, Gemini API, Automated Homework Assessment & Socratic Mentor)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages