Skip to content

variableway/innate-susu

Repository files navigation

AI Edu Platform

AI-powered education platform combining OpenMAIC and su-edu for interactive learning experiences.

Project Overview

This project integrates:

  • OpenMAIC: AI content generation engine for lessons, quizzes, and interactive content
  • su-edu/learn-together: Learner-facing application for studying with flashcards, quizzes, and progress tracking

Monorepo Structure

ai-edu/
├── apps/
│   ├── openmaic/          # AI content generation (Next.js 16 + React 19)
│   └── learner/           # Learning application (Next.js 14 + Tauri)
├── packages/
│   ├── @ai-edu/types/     # Shared TypeScript types
│   ├── @ai-edu/schemas/   # Zod schemas and validation
│   ├── @ai-edu/textbook-parser/  # Textbook parsing utilities
│   └── @ai-edu/tsconfig/  # Shared TypeScript configurations
├── OpenMAIC/              # Original OpenMAIC codebase
├── su-edu/                # Original su-edu codebase
└── tasks/                 # Project tasks and planning

Quick Start

Prerequisites

  • Node.js >= 20.9.0
  • pnpm >= 10.28.0

Installation

# Install dependencies for all packages
pnpm install

# Build shared packages
pnpm run --filter @ai-edu/* build

Development

# Run OpenMAIC only
pnpm dev:openmaic

# Run learner app only
pnpm dev:learner

# Run all apps
pnpm dev:all

Build

# Build all apps
pnpm build:all

Content Flow

  1. Textbook Ingestion: Parse PDFs into structured chapter JSON
  2. AI Generation: Use OpenMAIC to generate lessons, flashcards, quizzes
  3. Learning Experience: Consume content through the learner app

Architecture

Layer A: Textbook Ingestion

  • Input: PDF files from textbooks
  • Output: Structured chapter JSON files

Layer B: Content Understanding

  • Chapter summaries
  • Learning objectives
  • Key concepts and vocabulary

Layer C: AI Lesson Generation

  • Slide lessons
  • Quiz questions
  • Interactive scenes
  • Discussion prompts

Layer D: Learning Application

  • Chapter browsing
  • Flashcards
  • Quizzes
  • Progress tracking

Layer E: Desktop Packaging (Future)

  • Tauri wrapper for offline support
  • Local content caching

Shared Packages

@ai-edu/types

Core TypeScript interfaces for the entire platform.

import type { Chapter, LearningPackage, UserProgress } from '@ai-edu/types';

@ai-edu/schemas

Zod schemas for runtime validation.

import { validateChapter, ChapterSchema } from '@ai-edu/schemas';

const result = validateChapter(data);
if (result.success) {
  const chapter: Chapter = result.data;
}

@ai-edu/textbook-parser

Utilities for parsing textbook content.

import { ChapterParser, TextbookInfoParser } from '@ai-edu/textbook-parser';

const parser = new ChapterParser(sourceInfo);
const result = parser.parseChapter(rawText, chapterNumber, grade, subject, semester);

About

AI education for Susu

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors