Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 2.79 KB

File metadata and controls

59 lines (43 loc) · 2.79 KB

Monorail Documentation

A Server-Driven UI framework for Laravel + Inertia.js + React. The server emits complete UI schemas as JSON; the React client renders them deterministically. One source of truth, in PHP.

New here? Read Server-Driven UI for the pattern, then walk through the Quick Start.


Getting Started

  • Installation — Composer, service provider, Vite wiring, Tailwind source path.
  • Quick Start — scaffold a panel, generate a resource, see the list view in the browser.

Core Building Blocks

The four primitives you compose every admin screen from:

Primitive Docs What it is
Panel Panel Configuration The top-level container — routes, brand, middleware, discovery.
Resource Overview · Custom Pages · Relation Managers An Eloquent model bound to CRUD pages, a table, a form, and policies.
Page Overview · Blocks · Actions The unit of routing. Every screen — dashboard, list, edit, custom — is a Page subclass.
Widget Overview Dashboard tiles — stats, charts, recent records, activity feeds.

Feature Guides

Reference

  • Configuration — every config/monorail.php key, env variables, and vendor:publish tags (monorail-config, monorail-views, monorail-assets, monorail-lang, monorail-stubs).
  • CLI generatorsmonorail:make-panel, monorail:make-resource, monorail:make-page. Each is documented inline in its feature guide.

Concepts

  • Server-Driven UI — the pattern, the three-move extension mechanism (PHP class → React renderer → feature test), and when SDUI is the wrong tool.
  • Customizing the Frontend — register custom fields, widgets, blocks, and pages from your host app via createMonorail() without forking the package.

Contributing