Getting Started
Welcome to obeliOmed development. This guide gets you from zero to your first pull request.
What you are working with
obeliOmed is a suite of 17 specialised plugins built on FacturaScripts (FS), an open-source ERP written in PHP 8.x. Each plugin extends FS with ophthalmology-clinic functionality and shares a common multi-tenant foundation.
| Layer | What it is |
|---|---|
| FacturaScripts core | ERP framework — models, controllers, XML views, DB migrations |
| ObelioCore | Patient, expedition, clinic center management (base for all plugins) |
| 15 feature plugins | Scheduling, Surgery, Comms, Consents, Docs, Treatments, etc. |
| ObelioTheme | Shared CSS / JS design system used by all plugins |
Prerequisites
| Tool | Version | Purpose |
|---|---|---|
| PHP | 8.1+ | FacturaScripts core requirement |
| MySQL / MariaDB | 10.6+ | Main database |
| XAMPP | Any current | Local server stack on Windows |
| Composer | 2.x | PHP dependency management |
| Node.js | 20 LTS | Docs site (ObelioDocsSite) only |
| Git | Any current | Version control |
GitHub CLI gh | 2.x+ | PR workflow, secrets management |
Steps
- Install local environment — XAMPP + FacturaScripts + plugins
- Coding standards — Quick reference for all conventions
- Your first PR — Branch, code, tests, PR, Javi merges