> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pixlnext.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# STO Education Platform

> Comprehensive documentation for the STO Education Platform - A modern educational technology solution

<img className="block dark:hidden" src="https://mintlify.s3.us-west-1.amazonaws.com/pixlnexttechnologycorporation/logo.svg" alt="STO Education Platform" width="200" height="60" />

<img className="hidden dark:block" src="https://mintlify.s3.us-west-1.amazonaws.com/pixlnexttechnologycorporation/logo-dark.svg" alt="STO Education Platform" width="200" height="60" />

## Welcome to STO Education Platform

The STO Education Platform is a comprehensive educational technology solution that provides a multi-role learning management system with integrated video conferencing, payment processing, real-time communication, and administrative tools.

## What is STO Education Platform?

STO Education Platform is a modern, full-stack educational technology solution built with React, TypeScript, and Supabase. It serves as a comprehensive learning management system that connects students, teachers, parents, and administrators in a seamless educational ecosystem.

## Key Features

<CardGroup cols={2}>
  <Card title="Multi-Role System" icon="users" href="/docs/project-overview">
    Support for students, teachers, parents, trainees, and administrators with role-based access control
  </Card>

  <Card title="Live Video Conferencing" icon="video" href="/docs/integrations/video">
    Whereby video conferencing with screen sharing and participant management
  </Card>

  <Card title="Payment Processing" icon="credit-card" href="/docs/integrations/payments">
    Secure payment processing with PayMob integration for course enrollments and purchases
  </Card>

  <Card title="Real-time Communication" icon="message-circle" href="/docs/integrations/communication">
    SendBird-powered chat system with file sharing, group chats, and push notifications
  </Card>

  <Card title="Quiz & Assessment System" icon="clipboard-check" href="/docs/frontend/pages">
    Interactive quiz system with automated grading, feedback, and progress tracking
  </Card>

  <Card title="Teacher Mark Schemes" icon="book-open" href="/docs/frontend/services">
    Marketplace for teacher-created mark schemes with purchase and access management
  </Card>
</CardGroup>

## Technology Stack

<CardGroup cols={3}>
  <Card title="Frontend" icon="monitor">
    **React 18** + **TypeScript** + **Vite** + **Tailwind CSS**
  </Card>

  <Card title="Backend" icon="server">
    **Supabase** (PostgreSQL + Edge Functions + Auth + Storage)
  </Card>

  <Card title="Integrations" icon="plug">
    **Whereby Video** + **SendBird Chat** + **PayMob Payments** + **PostHog Analytics**
  </Card>
</CardGroup>

## Quick Start

<Steps>
  <Step title="Clone the Repository">
    ```bash theme={null}
    git clone https://github.com/sto-education/platform.git
    cd platform
    ```
  </Step>

  <Step title="Install Dependencies">
    ```bash theme={null}
    npm install
    ```
  </Step>

  <Step title="Set Up Environment Variables">
    Create a `.env` file with your configuration:

    ```bash theme={null}
    VITE_SUPABASE_URL=your_supabase_url
    VITE_SUPABASE_ANON_KEY=your_supabase_anon_key
    # ... other environment variables
    ```
  </Step>

  <Step title="Start Development Server">
    ```bash theme={null}
    npm run dev
    ```
  </Step>
</Steps>

## Documentation Structure

This documentation is organized into comprehensive sections covering every aspect of the platform:

### 🏗️ **Architecture & Overview**

* [Project Overview](/docs/project-overview) - Complete project overview and features
* [System Architecture](/docs/architecture) - Detailed architecture and design patterns

### 🎨 **Frontend Development**

* [Components](/docs/frontend/components) - All React components with detailed documentation
* [Pages](/docs/frontend/pages) - Every page component and routing structure
* [Context Providers](/docs/frontend/contexts) - State management and context usage
* [Services](/docs/frontend/services) - Business logic and API integration services
* [Utilities](/docs/frontend/utils) - Helper functions and utility classes
* [Type Definitions](/docs/frontend/types) - Complete TypeScript type documentation

### ⚙️ **Backend Development**

* [Supabase Functions](/docs/backend/supabase-functions) - All Edge Functions and server logic
* [Database Schema](/docs/backend/database-schema) - Complete database structure and relationships
* [API Endpoints](/docs/backend/api-endpoints) - All API endpoints and integrations

### 🔧 **Configuration & Setup**

* [Package Configuration](/docs/configuration/package-json) - Dependencies and scripts
* [Build Configuration](/docs/configuration/build-config) - Vite, TypeScript, and build setup
* [Environment Variables](/docs/configuration/environment) - All environment configurations

### 🔌 **Third-Party Integrations**

* [Supabase Integration](/docs/integrations/supabase) - Backend services and database
* [Payment Systems](/docs/integrations/payments) - PayMob payment processing
* [Video Conferencing](/docs/integrations/video) - Whereby video integration
* [Analytics & Monitoring](/docs/integrations/analytics) - PostHog and LogRocket
* [Communication Systems](/docs/integrations/communication) - SendBird chat integration

### 📜 **Scripts & Automation**

* [Build Scripts](/docs/scripts/build-scripts) - Build and deployment automation
* [Utility Scripts](/docs/scripts/utility-scripts) - Development and maintenance scripts

### 🗄️ **Database & Migrations**

* [Database Migrations](/docs/migrations/database-migrations) - All database schema changes
* [Schema Updates](/docs/migrations/schema-updates) - Database structure modifications

## What Makes This Documentation Special?

<AccordionGroup>
  <Accordion title="📁 Complete File Coverage">
    Every single file in the project is documented with its purpose, dependencies, and usage examples. No file is left undocumented.
  </Accordion>

  <Accordion title="🔗 Integration Mapping">
    Detailed documentation of how every third-party service integrates with the platform, including API endpoints, webhooks, and data flow.
  </Accordion>

  <Accordion title="🏗️ Architecture Clarity">
    Clear explanation of the system architecture, data flow, and how all components work together.
  </Accordion>

  <Accordion title="💻 Developer-Friendly">
    Practical examples, code snippets, and step-by-step guides for developers working on the platform.
  </Accordion>

  <Accordion title="🔧 Configuration Details">
    Comprehensive documentation of all configuration files, environment variables, and setup requirements.
  </Accordion>
</AccordionGroup>

## Support & Community

<CardGroup cols={2}>
  <Card title="GitHub Repository" icon="github" href="https://github.com/sto-education/platform">
    View source code, report issues, and contribute to the project
  </Card>

  <Card title="Discord Community" icon="discord" href="https://discord.gg/sto-education">
    Join our Discord community for support and discussions
  </Card>

  <Card title="Email Support" icon="mail" href="mailto:support@sto-education.com">
    Get direct support from our technical team
  </Card>

  <Card title="Live Demo" icon="external-link" href="https://sto-education.com">
    Try the platform with our live demo
  </Card>
</CardGroup>

## Contributing

We welcome contributions to the STO Education Platform! Please see our [GitHub repository](https://github.com/sto-education/platform) for contribution guidelines and development setup instructions.

## License

This project is licensed under the MIT License. See the [LICENSE](https://github.com/sto-education/platform/blob/main/LICENSE) file for details.

***

**Ready to dive in?** Start with our [Project Overview](/docs/project-overview) to understand the complete system, or jump directly to specific sections based on your needs.