Skip to content

README.md

Latest commit

 

History

History
192 lines (150 loc) · 8.27 KB

README.md

File metadata and controls

192 lines (150 loc) · 8.27 KB

Digi-Kul

Digital Gurukul — Bringing quality education to every corner of India, regardless of bandwidth

FastAPI Next.js Flutter License

The Problem

India's higher education system serves over 40,000 AICTE-affiliated institutions and millions of students. Government policy mandates digital education delivery, yet the physical infrastructure tells a different story: over 60% of students in Tier-2/3 cities and rural areas depend on fluctuating 2G/3G mobile connections on mid-range Android devices.

Mainstream platforms (Zoom, Google Meet, Microsoft Teams) require 5–10 Mbps of stable broadband to function. For most rural students, these tools are unusable—constant buffering, audio drops, and battery drain make sustained participation impossible.

The result is a widening digital divide where the students who need digital education the most are the least able to access it.

The Solution

Digi-Kul is an open-source, audio-first educational platform designed from the ground up for ultra-low bandwidth environments.

Capability Description
Audio-First Live Sessions WebRTC with automatic degradation: video → audio → text, based on real-time bandwidth detection
Offline-First Mobile App Study materials and quizzes cached locally via Isar. Quiz submissions queue offline and sync when connectivity returns
Multi-Tenant Architecture Each institution gets isolated data scoping. Teachers from Institution A cannot access Institution B data
PWA Web Dashboard Teachers and admins access the platform through a progressive web app — installable, cacheable, works on intermittent connections
Real-Time Collaboration Chat, whiteboard, polls, and hand-raise during live sessions via Socket.IO
Quiz Engine Offline-tolerant quiz taking with automatic grading and analytics

Architecture

┌─────────────────────────────────────────────────────────┐
│                     Digi-Kul Platform                    │
├───────────────┬──────────────────┬──────────────────────┤
│   Flutter     │    Next.js       │   FastAPI Backend     │
│  Mobile App   │    Web App       │                      │
│  (Students)   │ (Teachers +      │  57 REST endpoints   │
│               │  Admins)         │  Socket.IO events    │
│  Android/iOS  │  PWA             │  WebRTC signaling    │
└───────┬───────┴────────┬─────────┴──────────┬───────────┘
        │                │                    │
        └────────────────┴────────────────────┘
                         │
               ┌─────────▼──────────┐
               │     Supabase       │
               │  PostgreSQL + RLS  │
               │  File Storage      │
               └────────────────────┘
  • mobile/ — Flutter student app (Android/iOS). Audio-first session joining, offline material access, quiz taking with background sync queue.
  • frontend/ — Next.js teacher and admin web app. Live session hosting with WebRTC, material uploads, quiz creation, analytics dashboard. Ships as a PWA.
  • backend/ — FastAPI server. 57 REST API endpoints, Socket.IO real-time event layer, WebRTC signaling relay, JWT authentication, multi-tenant data scoping.

Tech Stack

Layer Technology Purpose
Mobile Flutter 3.19 + Dart 3.3 Student app — Android & iOS
Mobile State Riverpod + Freezed Reactive state + immutable models
Mobile Storage Isar 3.x Offline-first local database
Web Frontend Next.js (App Router, TypeScript) Teacher & admin dashboard (PWA)
Web Styling Tailwind CSS + shadcn/ui Component system
Backend FastAPI (Python 3.11) Async REST API + 57 endpoints
Real-Time Socket.IO + WebRTC Live sessions + signaling
Database Supabase (PostgreSQL) Multi-tenant data + RLS
File Storage Supabase Storage Materials + recordings
Auth JWT (Bearer tokens) Stateless authentication
Background Sync WorkManager (Flutter) Offline quiz submission queue
Notifications Firebase Cloud Messaging Push notifications

Getting Started

Prerequisites

  • Docker + Docker Compose
  • (Optional) Flutter 3.19+ for mobile development
  • (Optional) Node.js 18+ for frontend development
  • (Optional) Python 3.11+ for backend development

Quick Start (Docker)

git clone https://github.com/saivats/Digi-Kul.git
cd Digi-Kul
cp .env.example .env          # fill in Supabase + SMTP credentials
cp frontend/.env.example frontend/.env.local
docker-compose up --build
Service URL
Web App http://localhost (port 80 via nginx)
API http://localhost/api/health
Backend Direct http://localhost:8000
Frontend Direct http://localhost:3000

Manual Backend Setup

cd backend
python -m venv venv
venv\Scripts\activate          # Linux/Mac: source venv/bin/activate
pip install -r requirements.txt
uvicorn app.main:app --host 127.0.0.1 --port 8000

Manual Frontend Setup

cd frontend
npm install
npm run dev

Mobile App

cd mobile
flutter pub get
flutter run --dart-define=API_BASE_URL=http://10.0.2.2:8000 \
            --dart-define=SOCKET_URL=http://10.0.2.2:8000

Environment Variables

Backend (backend/.env)

SUPABASE_URL=https://your-project.supabase.co
SUPABASE_KEY=your-anon-key
SECRET_KEY=your-strong-random-secret
ALGORITHM=HS256
ACCESS_TOKEN_EXPIRE_HOURS=8
REFRESH_TOKEN_EXPIRE_DAYS=7
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_USERNAME=your-email@gmail.com
SMTP_PASSWORD=your-app-password
SMTP_SENDER_EMAIL=noreply@digikul.in
SMTP_SENDER_NAME=Digi-Kul
FRONTEND_URL=http://localhost:3000
CORS_ORIGINS=http://localhost:3000

Frontend (frontend/.env.local)

NEXT_PUBLIC_API_URL=http://localhost:8000
NEXT_PUBLIC_SOCKET_URL=http://localhost:8000
NEXT_PUBLIC_APP_NAME=Digi-Kul

Mobile (--dart-define)

API_BASE_URL=http://10.0.2.2:8000
SOCKET_URL=http://10.0.2.2:8000

Roadmap

  • Mobile Foundation — Isar offline database, JWT auth, Dio HTTP client, go_router navigation
  • Core Student Features — Dashboard, materials (offline download), attendance tracking
  • Live Sessions — WebRTC audio-first, Socket.IO, bandwidth-adaptive mode switching
  • Quiz Engine — Offline quiz taking, background sync queue, analytics
  • Backend (FastAPI) — 57 REST endpoints, WebRTC signaling, multi-tenant scoping, Socket.IO events
  • Web Frontend (Next.js) — Teacher/admin dashboards, live session hosting, PWA
  • Docker Deployment — Multi-service compose with nginx reverse proxy
  • Performance Testing — 3G throttled benchmarks, load testing
  • Production Hardening — Rate limiting, request logging, Sentry integration
  • Video Support — Selective video streaming for high-bandwidth students

Contributing

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature
  3. Commit with conventional commits: feat:, fix:, docs:
  4. Open a pull request against main
  5. All PRs must pass flutter analyze and npx tsc --noEmit

License

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

Digi-Kul is an open-source initiative. "Digi" from Digital, "Kul" from Gurukul — the ancient Indian institution of learning. Built to solve a real problem: every student deserves access to quality education, regardless of where they live or how fast their internet is.