This repository holds the official documentation for Webrium — a lightweight, modular PHP framework for building web applications and JSON APIs.
The contents of this repository are rendered as the documentation pages on webrium.dev.
Webrium is built around four small, focused packages that work together as a full-stack framework — or independently in any PHP project:
| Package | Purpose | Repository |
|---|---|---|
webrium/core |
Routing, controllers, requests, responses, sessions, validation, uploads, HTTP client, JWT, hashing, events, error handling, task scheduling | github.com/webrium/core |
webrium/foxdb |
Query builder, schema/migrations, ORM, relationships, collections, pagination | github.com/webrium/foxdb |
webrium/view |
Blade-compatible templating engine with hybrid static caching | github.com/webrium/view |
webrium/console |
The webrium CLI for scaffolding, migrations, plugins, and more |
github.com/webrium/console |
The webrium/webrium repository is the application skeleton that wires the four packages together with a sensible directory layout, default configuration, and an asset pipeline — a working application you can start building on immediately.
composer create-project webrium/webrium my-app
Each package is also independently usable. If you only need the database layer, install webrium/foxdb. If you only need the templating engine, install webrium/view. The documentation for each module begins with a self-contained introduction covering standalone installation.
The full framework — what it is, how to install it, and how a request flows through it.
The framework's core: routing, controllers, requests, responses, sessions, validation, uploads, HTTP client, JWT, hashing, events, filesystem, localization, and error handling.
- Introduction
- Routing
- Controllers
- Requests & Responses
- Sessions
- Validation
- File Uploads
- HTTP Client
- JWT
- Hashing
- Events
- Filesystem
- Localization
- Error Handling
- Helper Functions
- Kernel
- Task Scheduling
FoxDB — the query builder, ORM, schema builder, migrations, and seeders.
- Introduction
- Connections
- Query Builder
- Eloquent ORM
- Relationships
- Collections
- Casts & Serialization
- Pagination
- Migrations, Schema & Seeders
The view engine — a Blade-compatible templating system with hybrid static caching and an Editor.js parser.
- Introduction
- Basic Syntax
- Control Flow
- Layouts
- Components
- Hybrid Cache
- View Error Handling
- Editor.js Integration
The webrium command-line toolkit — scaffolding, migrations, database management, and plugins.
- Introduction
- Scaffolding
- Migrations & Seeders
- Database Management
- Diagnostics
- Plugins
- Task Scheduling
Found a typo, an outdated example, or a section that could be clearer? Pull requests and issues are very welcome. For larger structural changes, please open an issue first to discuss.
The documentation in this repository is released under the MIT License.