Understand the Architecture
Explore how the multi-tenant domain model, enrollment blueprint engine, modular plugins, and React portals connect in System Internals.
Introduction
KoAkademy Platform Documentation
Section titled “KoAkademy Platform Documentation”KoAkademy is an open-source, self-hosted school administration and learning management platform. It gives educational institutions complete ownership of student records, grades, enrollment workflows, and academic data without vendor lock-in or recurring per-seat fees.
Contribute Code & Docs
Build with PHP 8.5, Laravel 13, Filament 5, Inertia 3, React 19, Tailwind CSS 4, and Pest 5 using our canonical documentation workflow.
Self-Host on Your Servers
Run the one-line Docker Swarm installer to provision Caddy HTTPS, FrankenPHP application service, PostgreSQL, Redis, and Gotenberg PDF rendering.
Integrate via Public API
Interact with the tested beta API subset for general institution settings and cryptographic student verification.
Pick Your Path
Section titled “Pick Your Path”- Are you a new contributor? Head to the Contributing Guide to set up your environment, learn about our testing requirements, and see sample code. Check the Architecture Overview for an overview of data boundaries.
- Are you building a feature or extension? Explore the Frontend Guide, Auth & Authorization, Modules & Feature Flags, and Enrollment Policy Extensions.
- Are you deploying KoAkademy? Read the Installation Guide, followed by Configuration and Deployment & Backups.
- Are you operating a school? The User Guide covers daily administrative and faculty routines, while Enrollment Blueprints explains no-code policy configuration.
Technology Stack
Section titled “Technology Stack”| Layer | Technology | Details |
|---|---|---|
| Backend Framework | PHP 8.5, Laravel 13 | Service layer, Form Requests, Policies, strict types |
| Application Runtime | FrankenPHP (Octane) / Nginx | High-performance application worker in production Docker image |
| Admin Workspace | Filament 5 | Resource managers, Shield role permissions, custom widgets |
| User Portals | Inertia 3, React 19, TypeScript | Server-driven client rendering with SSR support (ssr.tsx) |
| Styling & Components | Tailwind CSS 4, shadcn/ui | Radix UI primitives, Lucide icons, accessible responsive layouts |
| Routing Helpers | Laravel Wayfinder | Generated typed TypeScript actions/routes (@/actions, @/routes) |
| Database & Cache | PostgreSQL, Redis | PostgreSQL for durable records, Redis for sessions, cache, and queues |
| Document Generation | spatie/laravel-pdf + Gotenberg | Chromium-based server-side PDF compilation |
| Testing Framework | Pest 5 | Feature and unit tests running in parallel against in-memory SQLite |
| Documentation Site | Astro 5 + Starlight | MDX collections, Pagefind search, single-source sync |
Open Source & Licensing
Section titled “Open Source & Licensing”KoAkademy is licensed under GNU AGPL-3.0-or-later. Commercial restrictions, artificial telemetry, or hidden paywalls are not included. All institutional data remains strictly on your chosen infrastructure.