LinguaAI Documentation

LinguaAI is a language-learning platform featuring a conversational AI tutor, real-time pronunciation feedback, and OCR-based text recognition. It is built with a Python FastAPI backend and a Flutter cross-platform mobile/web frontend.

Getting Started

• Project Overview
  • Key Features
  • Technology Stack
  • Repository Layout
  • Module Status
• Setup & Installation
  • Prerequisites
  • Backend Setup
  • Frontend Setup
  • Useful Commands
  • Deployment

Architecture

• System Architecture
  • High-Level Overview
  • Backend Architecture
  • Authentication Flow
  • Real-time Pronunciation Scoring (Planned)
  • Security Considerations
• Database
  • Custom Types (Enums)
  • Tables
  • Database Triggers
  • PostgreSQL Extensions
  • Planned Tables

API Reference

• API Reference
  • Base URL
  • Interactive Documentation
  • Authentication
  • Response Format
  • HTTP Status Codes
  • General Endpoints
  • Available Modules
• Authentication API
  • Schemas
  • Endpoints
  • Summary Table
• Dictionary API
  • Endpoints
• Flashcards API
  • Endpoints
• Lessons API
  • Endpoints
• Gamification API
  • Endpoints
• Users API
  • Endpoints

Frontend

• Frontend
  • Project Structure
  • Entry Point (main.dart)
  • Theme
  • Services
  • Local Storage (SQLite)
  • Screens
  • Reusable Widgets
  • Key Dependencies

Development

• Testing
  • Test Configuration
  • Running Tests
  • Directory Structure
  • Fixtures (conftest.py)
  • Unit Tests (tests/unit/test_auth_module.py)
  • Integration Tests (tests/integration/test_auth.py)
  • Writing New Tests
  • Test Dependencies

Indices and Tables

• Index

• Module Index

• Search Page