Skip to content
@openschool-org

OpenSchool

Open digital platform for Sri Lankan schools.

OpenSchool

Open Digital Platform for Sri Lankan Schools 🇱🇰

License Backend CI Frontend CI Release Last Commit

OpenSchool is an open-source school management platform for Sri Lankan government schools. It brings the everyday work of running a school into one system: student and staff records, classes, attendance, curriculum, timetables, marks, leave, notifications, reports and administration. Schools run it on infrastructure they control, so student data stays local, and it is free to use under the Apache License 2.0.

Why OpenSchool? • Key Features • Architecture • Repositories • Getting Started • Contributing • License


Why OpenSchool?

Many Sri Lankan schools still keep their records on paper or across several disconnected tools. Information is hard to find, hard to keep up to date, and hard to share safely with teachers, students and parents. Commercial school systems often cost too much, lock schools into one vendor, or store children's data on foreign-hosted services.

OpenSchool gives a school one clear system for this work, built around how Sri Lankan schools actually operate: grades and streams, A/L subject choices, class medium, houses and prefects, NIC-based identities, Sinhala and Tamil, and the year-end cycle of promotion and class formation.

  • Sovereign by design. A school or public-sector body installs OpenSchool on servers it owns or manages. Student and administrative data never leaves that infrastructure.
  • No licence fees, no lock-in. Every part of the platform is open source under the Apache License 2.0.
  • Secure by default. Sign-in is handled by ThunderID, an open-source identity provider. The server checks every request against the caller's role, position and assigned classes. A parent or student only ever sees their own data.
  • Simple to operate. One Go program, one web app and one PostgreSQL database. There is no queue, cache or separate worker to look after.

Key Features

Feature Status
School setup: academic years, grades, classes, streams, houses and a resource map of rooms and labs Completed
People: student, teacher, guardian and non-academic staff records, with Sri Lankan name formats Completed
Attendance: daily student and staff attendance, with session locking and late counts Completed
Academics: subjects, preset curricula, A/L stream placement, subject choices and term marks Completed
Timetables: generation, review by section heads, and publishing Completed
Year-end workflows: guided year rollover, intake, promotion, class formation and teacher allocation Completed
Teacher leave: applications, relief teachers, Principal approval and leave balances Completed
Self-service activation: school-issued activation codes for student and parent accounts Completed
Four portals: separate experiences for administrators, teachers, students and parents Completed
Notifications and reports: in-app notices, dashboards, analytics and an audit log Completed
Automation agents: scheduled integrity, compliance, security and backup checks Completed
Sinhala and Tamil for the student and parent portals In Progress

View the complete feature guide →


Architecture

System overview

OpenSchool has two parts: a web app that people use, and an API server that holds the rules and talks to the database. ThunderID signs people in, and PostgreSQL stores all the data. A school runs all of it on its own servers.

OpenSchool system overview

Part What it does
Web app One React app with four portals: admin, teacher, student and parent. The user's role decides which portal opens.
API server One Go program. Each area of the school (attendance, timetable, people and so on) is a separate module. It also runs scheduled checks and nightly backups.
ThunderID Signs users in and keeps their passwords. OpenSchool never stores a login password.
PostgreSQL Stores all school data in one database.

How a request works

Every request carries a token from ThunderID. The API checks the token locally against cached signing keys, so most requests never call ThunderID. Then the API decides whether this person may see this specific record.

How a request works

  1. Sign-in: the web app sends the user to ThunderID, which returns a signed access token.
  2. Portal selection: the web app reads the role from the token and shows the admin, teacher, student or parent portal.
  3. Token check: the API verifies the token's signature, issuer and expiry against ThunderID's signing keys, which it caches and refreshes on its own.
  4. Authorization: the API checks the role, the teacher's in-app position (Principal, Section Head, Class Teacher and so on), and access to the specific class or student. The server makes every decision. The web app only hides what a role cannot use.
  5. Data access: the module's repository runs type-safe SQL, generated by sqlc, against PostgreSQL.

Inside the backend

Modules never reach into each other's tables. When one module needs something from another, it asks through a small interface that the composition root wires up.

Inside the backend

The web app mirrors this layout: one folder for each feature, each with its own API calls, queries, components and pages. Lint rules enforce the boundaries.

Read the full architecture guide →

Open-source components

OpenSchool is built entirely on open-source technology:


Repositories

To contribute, go to a repository and read its CONTRIBUTING.md.

Repository What it holds
openschool The platform: Go backend, React frontend, database migrations, ThunderID configuration and documentation
.github This profile, plus the default contributing guide, security policy and issue templates for every repository in the organisation

Getting Started

You need Go 1.26+, Node.js 24 with pnpm, and Docker with Docker Compose.

git clone https://github.com/openschool-org/openschool.git
cd openschool

make setup   # start PostgreSQL and ThunderID, configure the environment, install dependencies
make seed    # optional: load a demo class with teachers, students, parents and marks
make dev     # run the backend on :8080 and the frontend on :5173

Open http://localhost:5173 and create the first administrator account.

Guide What it covers
Server setup Installing OpenSchool, production settings and backups
School setup First admin, the school wizard, teachers, students, timetables and parents
ThunderID Configuring the identity provider
Architecture decisions Why key technical decisions were made
Changelog Release history

Warning

OpenSchool is under active development. Features, interfaces and data models can change between releases.

Contributing

OpenSchool is built in the open, and we welcome contributions of every size: bug reports, feature ideas, documentation, translations, design and code.

Security: do not report a vulnerability in a public issue. Use private vulnerability reporting. Our security policy gives the details.

License

All OpenSchool repositories are open source under the Apache License 2.0.

Built with care, for schools across Sri Lanka.

Pinned Loading

  1. openschool openschool Public

    Open digital platform for Sri Lankan schools.

    Go 40 3

Repositories

Showing 6 of 6 repositories

Top languages

Loading…

Most used topics

Loading…