KoAkademy
Self-hosted school administration and learning platform — Laravel 13, Filament 5, Inertia 3, and React 19 in a containerized FrankenPHP stack. Understand the system, contribute, or deploy it.
Quick Path Selection
Section titled “Quick Path Selection”Choose your role to get straight to the relevant guides:
New Contributor Set up your local environment, write Pest tests, build React portals, and submit clean PRs.
System Architect Explore the domain model, multi-layer authorization, enrollment engine, and Pennant feature flags.
Self-Host Operator Deploy with the single-node Docker Swarm installer, Caddy HTTPS, PostgreSQL, Redis, and Gotenberg.
School Staff & Registrar Daily operational workflows, student management, and no-code enrollment blueprint configuration.
For Contributors & Developers
Section titled “For Contributors & Developers”Everything needed to develop features, understand system internals, and run tests locally.
Development Setup PHP 8.5, Laravel 13, Pest 5, Vite 8 — from clone to running test suites.
Contributing Guide Contributor workflow, sample code, review checklist, and documentation rules.
Frontend Architecture Inertia 3, React 19, Wayfinder typed route helpers, and the shadcn/Tailwind design system.
Auth & Authorization Web/Sanctum guards, 2FA/passkeys, role hierarchies, and policy enforcement.
Modules & Feature Flags Bundled vs. standalone Composer modules and Pennant class-based feature flags.
Enrollment Policy Extensions Add custom rules, actions, and strategies to the enrollment engine safely.
Regulatory Report Providers Add compatible jurisdiction-specific adapters while keeping CHED as the only built-in provider.
For Maintainers
Section titled “For Maintainers”Repository automation, releases, and CI/CD pipelines.
CI Pipeline PR classification, Pest test runners, actionlint, zizmor security scans, and merge queue.
Releases & Versioning Release Please automation, semantic versioning, and immutable container images.
Create a Module Build, test, and release a standalone Composer module package.
Module Registry Publish and distribute signed catalog entries for the module ecosystem.
Documentation System Canonical root Markdown, sync scripts, and Starlight MDX structure.
Repository Automation Issue labeling, project roadmap boards, and automated workflows.
For Operators
Section titled “For Operators”Production deployment, service contracts, and operational troubleshooting.
Installation Guide One-line Linux installer for Docker Swarm with Caddy reverse proxy.
Deployment & Upgrades Zero-downtime updates, database migrations, backups, and rollback.
Configuration Environment variables, Docker secrets, S3/R2 storage, and SMTP setup.
Troubleshooting & FAQ Container diagnostics, database connectivity, PDF generation, and common fixes.