Current development
Breaking change: data loss
Moving an existing V2 installation to this development code is a breaking change with data loss in the live database. The migrations delete legacy academic records and remove schema columns. They do not automatically convert all V2 records into the new academic model. Selected JSON archives do not prevent this live-data removal and have no automatic restore or re-import workflow. Affected migrations cannot restore the deleted records through rollback.
Do not run these migrations on a live V2 database as a routine update. Test a specific migration plan on an isolated restored copy first. Keep a verified full database backup, uploaded files, and the original APP_KEY before proceeding. See the upgrade details.
Skuul manages organizations and campuses, enrollment, teaching, assessment, finance, and campus services. These guides cover the implemented application and its main user, administrator, and developer workflows.
Version scope
These guides describe the current development code, which uses Laravel 13 and Livewire 4. This code is not the published V2 release. Use the V2 guides for an older installation. Check the release notes before upgrading.
Choose your starting point
| Your task | Start here |
|---|---|
| Evaluate or install Skuul | Requirements and installation. |
| Set up an organization or campus | Organizations and campus setup. |
| Follow your role's daily tasks | Instructions by role, including specialist staff duties. |
| Manage access | Accounts and roles. |
| Enroll learners | Students, admissions, and guardians. |
| Plan teaching | Calendars, structure, and offerings. |
| Record teaching and assessment | Attendance, syllabi, and gradebooks. |
| Publish results | Result approval and documents. |
| Manage money | Invoices, payments, and ledger. |
| Use family access | Family portal and requests. |
| Maintain a deployment | Deployment, operations, and updating. |
| Develop or extend Skuul | Development, architecture, and extensions. |
The sidebar contains the remaining campus-service guides, including notices, student care, staff, facilities, boarding, library, imports, and reports. Application terms explains names used across the guides.
Routine work and handover
Follow daily campus checks for teaching, office, services, and unfinished work. Use staff access review for joiners, duty changes, leavers, and returning staff. Use academic handover at period closure and before the next cycle. Use finance reconciliation before financial closure. Use service recovery when deployment components fail.
First campus workflow
Follow the worked campus exercise for sample inputs and expected results.
- Install Skuul and create the first platform administrator, organization, and campus.
- Complete campus settings, terminology, time zone, and feature choices.
- Create the academic calendar, levels, sections, and teaching model.
- Add staff and learners with their campus access.
- Link guardians and issue account invitations.
- Create subjects, offerings, teaching assignments, and timetables.
- Prepare syllabi and gradebook assessments.
- Record attendance and grades during the open period.
- Review and approve result revisions.
- Close teaching periods and publish eligible official documents.
Finance, boarding, library, and other services have their own prerequisites and state controls. Prepare backups and monitoring before entering live data. The browser installer lets you choose administrator credentials. There is no default production password.
Scope and known limits
Read the current limits before promising a feature to users. The coverage inventory identifies the reviewed source areas and workflow guides. For a problem, follow troubleshooting and include reproducible steps in the application issue tracker.