Skip to main content
STO Education Platform

​
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

Multi-Role System

Support for students, teachers, parents, trainees, and administrators with role-based access control

Live Video Conferencing

Integrated 100ms video conferencing with screen sharing, recording, and participant management

Payment Processing

Secure payment processing with PayMob integration for course enrollments and purchases

Real-time Communication

SendBird-powered chat system with file sharing, group chats, and push notifications

Quiz & Assessment System

Interactive quiz system with automated grading, feedback, and progress tracking

Teacher Mark Schemes

Marketplace for teacher-created mark schemes with purchase and access management

​
Technology Stack

Frontend

React 18 + TypeScript + Vite + Tailwind CSS

Backend

Supabase (PostgreSQL + Edge Functions + Auth + Storage)

Integrations

100ms Video + SendBird Chat + PayMob Payments + PostHog Analytics

​
Quick Start

1

Clone the Repository

git clone https://github.com/sto-education/platform.git
cd platform
2

Install Dependencies

npm install
3

Set Up Environment Variables

Create a .env file with your configuration:
VITE_SUPABASE_URL=your_supabase_url
VITE_SUPABASE_ANON_KEY=your_supabase_anon_key
# ... other environment variables
4

Start Development Server

npm run dev

​
Documentation Structure

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

​
🏗️ Architecture & Overview

​
🎨 Frontend Development

  • Components - All React components with detailed documentation
  • Pages - Every page component and routing structure
  • Context Providers - State management and context usage
  • Services - Business logic and API integration services
  • Utilities - Helper functions and utility classes
  • Type Definitions - Complete TypeScript type documentation

​
⚙️ Backend Development

​
🔧 Configuration & Setup

​
🔌 Third-Party Integrations

​
📜 Scripts & Automation

​
🗄️ Database & Migrations

​
What Makes This Documentation Special?

Every single file in the project is documented with its purpose, dependencies, and usage examples. No file is left undocumented.
Detailed documentation of how every third-party service integrates with the platform, including API endpoints, webhooks, and data flow.
Clear explanation of the system architecture, data flow, and how all components work together.
Practical examples, code snippets, and step-by-step guides for developers working on the platform.
Comprehensive documentation of all configuration files, environment variables, and setup requirements.

​
Support & Community

GitHub Repository

View source code, report issues, and contribute to the project

Discord Community

Join our Discord community for support and discussions

Email Support

Get direct support from our technical team

Live Demo

Try the platform with our live demo

​
Contributing

We welcome contributions to the STO Education Platform! Please see our GitHub repository for contribution guidelines and development setup instructions.

​
License

This project is licensed under the MIT License. See the LICENSE file for details.
Ready to dive in? Start with our Project Overview to understand the complete system, or jump directly to specific sections based on your needs.