Skip to content

shihan84/Ai-HomeSchooling

Repository files navigation

AI Homeschool System

An advanced AI-powered homeschool education system designed specifically for the Indian education system, providing comprehensive learning solutions from Nursery to Class 12.

๐ŸŒŸ Features

Core Features

  • AI Teacher: Real-time voice and text interaction with AI tutor for instant explanations
  • Adaptive Testing: Automated weekly tests with difficulty that adjusts based on performance
  • Learning Paths: Personalized curriculum paths based on strengths and weaknesses
  • Progress Tracking: Comprehensive analytics and reporting for students and parents

Indian Education System Integration

  • Multiple Boards: Support for CBSE, ICSE, State Boards, NIOS, IB, and Cambridge curricula
  • Indian Subjects: Comprehensive coverage of NCERT curriculum and regional subjects
  • Multilingual Support: Available in English, Hindi, and major regional languages (11+ languages)
  • Grade Coverage: Complete curriculum from Nursery to Class 12

Technical Features

  • Responsive Design: Optimized for tablets and mobile devices
  • Real-time Communication: WebSocket integration for live interactions
  • Database: Prisma ORM with SQLite for efficient data management
  • Modern UI: Built with Next.js 15, TypeScript, and shadcn/ui components

๐Ÿš€ Quick Start

Prerequisites

  • Node.js 18+
  • npm or yarn
  • Git

Installation

  1. Clone the repository

    git clone https://github.com/shihan84/Ai-HomeSchooling.git
    cd Ai-HomeSchooling
  2. Install dependencies

    npm install
  3. Set up environment variables

    cp .env.example .env

    Edit .env file with your configuration:

    DATABASE_URL="file:./dev.db"
    NEXTAUTH_SECRET="your-nextauth-secret"
    NEXTAUTH_URL="http://localhost:3000"
  4. Set up database

    # Generate Prisma client
    npm run db:generate
    
    # Push schema to database
    npm run db:push
    
    # Seed database with Indian curriculum
    npm run db:seed
  5. Start development server

    npm run dev
  6. Open your browser Navigate to http://localhost:3000

๐Ÿ“š Project Structure

Ai-HomeSchooling/
โ”œโ”€โ”€ prisma/
โ”‚   โ”œโ”€โ”€ schema.prisma          # Database schema
โ”‚   โ””โ”€โ”€ seed.ts               # Database seed script
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ app/                  # Next.js app router pages
โ”‚   โ”‚   โ”œโ”€โ”€ page.tsx         # Main landing page
โ”‚   โ”‚   โ”œโ”€โ”€ student/         # Student dashboard
โ”‚   โ”‚   โ”œโ”€โ”€ parent/          # Parent dashboard
โ”‚   โ”‚   โ”œโ”€โ”€ test/            # Test system
โ”‚   โ”‚   โ”œโ”€โ”€ learning-path/   # Learning paths
โ”‚   โ”‚   โ””โ”€โ”€ reports/         # Progress reports
โ”‚   โ”œโ”€โ”€ components/          # React components
โ”‚   โ”‚   โ””โ”€โ”€ ui/             # shadcn/ui components
โ”‚   โ””โ”€โ”€ lib/                # Utility libraries
โ”‚       โ”œโ”€โ”€ db.ts           # Database client
โ”‚       โ”œโ”€โ”€ indian-curriculum.ts # Indian curriculum data
โ”‚       โ””โ”€โ”€ socket.ts       # WebSocket configuration
โ”œโ”€โ”€ public/                 # Static assets
โ”œโ”€โ”€ package.json           # Dependencies and scripts
โ””โ”€โ”€ README.md             # This file

๐ŸŽฏ Key Components

1. AI Teacher System

  • Voice interaction simulation
  • Intelligent response generation
  • Subject-specific knowledge base
  • Context-aware explanations

2. Adaptive Testing Engine

  • Dynamic question generation
  • Difficulty adjustment algorithms
  • Real-time scoring and feedback
  • Performance analytics

3. Learning Path Management

  • Personalized curriculum planning
  • Progress tracking per topic
  • Goal-oriented learning
  • Parental oversight

4. Progress Reporting

  • Visual charts and graphs
  • Subject-wise mastery levels
  • Time tracking and analytics
  • Comparative performance analysis

๐Ÿ‡ฎ๐Ÿ‡ณ Indian Curriculum Support

Supported Education Boards

  • CBSE (Central Board of Secondary Education)
  • ICSE (Indian Certificate of Secondary Education)
  • State Boards (Various state education boards)
  • NIOS (National Institute of Open Schooling)
  • IB (International Baccalaureate)
  • Cambridge (Cambridge Assessment International Education)

Supported Languages

  • English
  • Hindi
  • Bengali
  • Tamil
  • Telugu
  • Marathi
  • Gujarati
  • Kannada
  • Malayalam
  • Punjabi
  • Urdu

Grade Structure

  • Primary: Classes 1-5
  • Upper Primary: Classes 6-8
  • Secondary: Classes 9-10
  • Senior Secondary: Classes 11-12

๐Ÿ› ๏ธ Development

Available Scripts

npm run dev          # Start development server
npm run build        # Build for production
npm run start        # Start production server
npm run lint         # Run ESLint
npm run db:push      # Push schema changes to database
npm run db:generate  # Generate Prisma client
npm run db:seed      # Seed database with sample data
npm run db:reset     # Reset database

Database Schema

The system uses Prisma ORM with SQLite. Key models include:

  • User: User authentication and roles
  • Student: Student profiles and grade information
  • Parent: Parent profiles and student relationships
  • Subject: Curriculum subjects with board alignment
  • Topic: Subject topics with difficulty levels
  • Question: Test questions with various types
  • Test: Adaptive test configurations
  • Progress: Student progress tracking
  • LearningPath: Personalized learning paths

API Routes

  • /api/auth/* - Authentication endpoints
  • /api/students/* - Student management
  • /api/subjects/* - Subject and topic management
  • /api/tests/* - Test generation and scoring
  • /api/progress/* - Progress tracking

๐Ÿš€ Deployment

Vercel Deployment (Recommended)

  1. Push to GitHub

    git add .
    git commit -m "Initial commit"
    git push origin main
  2. Deploy to Vercel

    • Connect your GitHub repository to Vercel
    • Configure environment variables
    • Deploy automatically

Docker Deployment

# Build Docker image
docker build -t ai-homeschool .

# Run container
docker run -p 3000:3000 ai-homeschool

Manual Deployment

# Build for production
npm run build

# Start production server
npm start

๐Ÿ”ง Environment Variables

Variable Description Default
DATABASE_URL Database connection string file:./dev.db
NEXTAUTH_SECRET NextAuth secret key Required
NEXTAUTH_URL NextAuth URL http://localhost:3000
NODE_ENV Environment mode development

๐Ÿค Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

๐Ÿ“„ License

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

๐Ÿข Company

Morus Broadcasting Pvt Ltd ยฉ 2024 Morus Broadcasting Pvt Ltd. All rights reserved.

๐Ÿ“ž Support

For support and inquiries:

๐Ÿ™ Acknowledgments

  • Next.js team for the excellent framework
  • Prisma team for the powerful ORM
  • shadcn/ui for the beautiful components
  • Indian education boards for curriculum standards
  • All contributors and supporters of open-source education

Empowering education through AI technology | Indian Curriculum Aligned

About

Ai powered home schooling

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors