Socratic IDE

A local-first AI coding tutor that quizzes developers on their own code to ensure understanding before commits.

Architecture

Socratic IDE uses a "Trinity Architecture" with three main components:

• THE BODY (Rust/Tauri) - Desktop application, file watching, state management
• THE MIND (Python/FastAPI) - LLM orchestration, quiz generation, chat explanations
• THE ENGINE (Ollama) - Local LLM inference for privacy and zero API costs

Features

• Code Quizzing - Generate quizzes about your codebase to test understanding
• Code Explanations - Chat with an AI about any file or function
• Syntax Highlighting - View code with language-aware highlighting
• Function Extraction - Automatically detect and list functions (Rust, Python, TypeScript, JavaScript)
• Local-First - All processing happens locally via Ollama

Prerequisites

• Node.js (v18+)
• Rust (latest stable)
• Python (3.10+)
• Ollama with a model installed (e.g., llama3)

Installation

# Clone the repository
git clone https://github.com/yourusername/socratic-ide.git
cd socratic-ide

# Install dependencies
npm run setup

# Pull an Ollama model (if you haven't already)
ollama pull llama3

Quick Start

# Terminal 1: Start Ollama
ollama serve

# Terminal 2: Start the application
npm run dev:all

Or let Tauri manage everything:

# Ollama must be running first
npm run tauri dev

Development

# Run all tests
npm run test          # Frontend (Vitest)
npm run test:rust     # Rust (cargo test)
npm run test:python   # Python (pytest)

# Lint code
npm run lint          # ESLint
npm run lint:rust     # Clippy
npm run lint:python   # Ruff

Project Structure

socratic-ide/
├── desktop/
│   ├── core/         # Rust/Tauri backend
│   └── interface/    # React frontend
├── agent/            # Python FastAPI server
├── .ai_context/      # AI assistant documentation
└── scripts/          # Development utilities

Documentation

For detailed documentation, see the .ai_context/ directory:

• ARCHITECTURE.md - System design and data flow
• ROADMAP.md - Development phases and goals
• SESSION_LOG.md - Development progress tracker

Current Status

• Phase 1: Infrastructure (Complete)
• Phase 2: LLM Integration (In Progress)

See ROADMAP.md for the full development plan.

License

MIT