Open-source AI-powered learning platform

Learn smarter with AI-powered exam prep, multi-agent problem solving, knowledge graphs, and more.

Quick Start | Features | Contributing | Documentation

English | 日本語 | 中文 | 한국어 | Español | Français | Deutsch | Português | العربية | বাংলা | हिन्दी | Русский

Studyield is an open-source AI-powered learning platform that helps students study more effectively through personalized content, intelligent tutoring, and adaptive assessments. It combines 6 killer AI features with a comprehensive study toolkit, available on both web and mobile.

git clone https://github.com/studyield/studyield.git
cd studyield
cp backend/.env.example backend/.env
# Edit backend/.env with your database credentials and OpenRouter API key
docker compose --env-file .env.docker up -d

Access the app at http://localhost:5189 and the API at http://localhost:3010.

Prerequisites: Node.js 20+, PostgreSQL 15+, Redis 7+

# Clone
git clone https://github.com/studyield/studyield.git
cd studyield

# Backend
cd backend
cp .env.example .env    # Edit .env with your configuration
npm install
npm run migrate
npm run start:dev

# Frontend (new terminal)
cd frontend
cp .env.example .env
npm install
npm run dev

Visit http://localhost:5189 to access the app.

./start.sh

This starts PostgreSQL, Redis, Qdrant, and ClickHouse via Docker, then launches the backend and frontend dev servers.

• Knowledge Base -- Upload documents (PDF, DOCX) for semantic search and RAG
• Flashcards with SRS -- Spaced repetition system for optimal memorization
• AI-Generated Quizzes -- Automatic quiz generation from study materials
• RAG Chat -- Conversational AI with citations from your documents
• Learning Paths -- AI-generated optimal study routes
• Progress Analytics -- Track study time, mastery levels, and learning velocity

• 12 Languages -- Full i18n support (EN, JA, ZH, KO, ES, FR, DE, PT, AR, BN, HI, RU)
• Web + Mobile -- React frontend and Flutter mobile app
• Real-Time -- WebSocket updates for AI streaming, chat, and processing progress
• Self-Hosted -- Run on your own infrastructure with Docker Compose
• Stripe Billing -- Subscription management built-in
• OAuth -- Google and Apple sign-in

studyield/
├── backend/                 # NestJS API Server (27 modules, 120+ endpoints)
│   ├── src/modules/         # auth, ai, content, knowledge-base, chat, quiz,
│   │                        # exam-clone, problem-solver, teach-back, research,
│   │                        # code-sandbox, learning-paths, subscription, ...
│   └── migrations/          # Database migrations (27 tables)
├── frontend/                # React 19 Web App
│   ├── src/pages/           # 24+ route pages
│   ├── src/components/      # Radix UI components
│   ├── src/locales/         # 12 language translations
│   └── src/services/        # 15+ API service clients
├── mobile/                  # Flutter Mobile App (iOS + Android)
│   ├── lib/screens/         # App screens
│   ├── lib/providers/       # State management
│   └── assets/translations/ # 12 language translations
├── docker-compose.yml       # One-command self-hosting
├── start.sh                 # Development startup script
└── .github/workflows/       # CI/CD pipelines

• Node.js 20+ | PostgreSQL 15+ | Redis 7+
• Qdrant (optional) | ClickHouse (optional) | Flutter 3.10+ (for mobile)
• Docker & Docker Compose (recommended)

# Backend
cd backend && npm run lint && npm run build

# Frontend
cd frontend && npm run lint && npm run typecheck && npm run build

# Mobile
cd mobile && flutter analyze && flutter test

We welcome contributions! See CONTRIBUTING.md for guidelines.

• Bug Reports
• Feature Requests
• Discussions

Please report security vulnerabilities responsibly. See SECURITY.md for our disclosure policy.

This project is licensed under the Apache License 2.0.

Copyright 2025 Studyield Contributors.