Documentation
How to run, host and contribute to MyPortal — the open-source school MIS.
MyPortal is an open-source information management system for UK schools. It is built as an ASP.NET Core Web API with an Angular single-page application in front of it, and it stores its data in SQL Server.
These docs cover getting a local instance running, understanding how the pieces fit together, and contributing changes back.
MyPortal is not production-ready. Core services and the foundational modules work, but the system should not be holding live school data yet. Run it against test data.
Where to start
- Getting started — prerequisites, database setup, and the commands to bring the API and SPA up locally.
- Architecture — what each project in the solution is responsible for, and how SQL is managed.
- Contributing — how to propose work, and where help is most useful right now.
Getting help
Questions and ideas belong in GitHub Discussions. Bugs and concrete pieces of work belong in the issue tracker.