laravelui5/core

Foundation layer for integrating OpenUI5 into Laravel applications. Provides the runtime and developer tooling to build UI5 apps in a Laravel-native workflow.

v1.1.10 2025-11-15 09:36 UTC

Requires

• php: ^8.3
• ext-dom: *
• ext-libxml: *
• ext-simplexml: *
• doctrine/dbal: ^4.3
• flat3/lodata: dev-ServiceLocator
• illuminate/console: ^12.0
• illuminate/contracts: ^12.0
• illuminate/database: ^12.0
• illuminate/filesystem: ^12.0
• illuminate/http: ^12.0
• illuminate/routing: ^12.0
• illuminate/support: ^12.0
• illuminate/view: ^12.0
• league/flysystem: ^3.0
• symfony/yaml: ^7.2

Requires (Dev)

• orchestra/testbench: ^10.6
• pestphp/pest: ^4.0
• pestphp/pest-plugin-laravel: ^4.0
• phpunit/phpunit: 12.3.7

Suggests

• flat3/lodata: Provides OData v4 support. This package uses a fork (branch ServiceLocator) until upstream support for multiple endpoints is merged.

Apache-2.0

• Michael Gerzabek

• sdk
• laravel
• adminpanel
• enterprise
• odata
• laravel-package
• openui5
• ui5
• fiori
• microfrontend
• enterprise-apps

README

Seamless SAP OpenUI5 integration for Laravel backends.

A production-ready integration layer to run SAP OpenUI5 frontends seamlessly on Laravel backends. Full support for SAP-compliant Security Token Handling (X-CSRF-Token), OData v4 services, and hybrid UI5 + Laravel APIs.

Built to bridge the worlds of enterprise-grade UI5 frontends and modern Laravel application backends. With simplicity, security, and full SAP compatibility in mind.

For comprehensive documentation and usage examples, please visit laravelui5.com.

Features

• Native integration of OpenUI5 micro apps into Laravel projects
• Comprehensive UI5 registry for apps, libraries, cards, resources, reports and tiles
• Systematic deployment and versioning model, enterprise-ready
• Centralized proxy, security, and CSRF handling infrastructure
• Action Controller and Settings API enabling process-oriented logic
• Automatic OData $metadata generation from Laravel models
• Supports annotations and typed schemas, enabling real business app scenarios
• Focus on modular, context-driven frontends

For teams who want a complete developer experience with additional productivity features, UI patterns, and prebuilt business modules, a separate commercial Sdk will be available at pragmatiqu.io.

Roadmap

See the Roadmap for details on Core status, maintenance, and upcoming features.

Security

If you discover a security vulnerability, please send an encrypted mail to [e-mail].
A public key will be provided on request until we publish it at https://laravelui5.com/security.

Contributing

Contributions are welcome and appreciated!

If you’d like to submit a bugfix, improve the documentation, or suggest an enhancement:

1. Fork the repo
2. Create your feature branch (git checkout -b feature/your-feature)
3. Commit your changes (git commit -am 'Add your feature')
4. Push to the branch (git push origin feature/your-feature)
5. Open a Pull Request

Please make sure to follow PSR-12 and existing architectural conventions. We also recommend discussing larger ideas via an issue before submitting a PR.

License

This package is open-sourced software licensed under the ASF 2.0.

Links

To help you go further with LaravelUi5 and its surrounding ecosystem, this section provides curated links to key resources across UI5, Laravel, and OData. Whether you're exploring SAP Fiori UX, building Laravel-integrated UI5 modules, or deepening your understanding of OData v4, these references offer a solid foundation for development, troubleshooting, and architectural decisions.

UI5

• Official OpenUI5 Website https://openui5.org/
  → Intro, tutorials, and SDK download.

• OpenUI5 SDK https://sdk.openui5.org/
  → Complete API reference for all sap.* libraries.

• UI5 Web Components https://sap.github.io/ui5-webcomponents/
  → Framework-agnostic UI5-style components for e.g. React, Vue, etc.

• UI5 Tooling https://sap.github.io/ui5-tooling/v3/
  → CLI & build system to manage UI5 apps in modern workflows.

• SAP Fiori Design Guidelines https://experience.sap.com/fiori-design-web/
  → Best Practices for UI5 Development (Layout, UX, Typography etc.)

Laravel

• Laravel Official Docs https://laravel.com/docs
  → Always the best place to start and return to.

• Laravel News https://laravel-news.com/
  → Articles, releases, packages, tutorials.

• Laracasts https://laracasts.com/
  → High-quality screencasts for Laravel and the PHP ecosystem.

• Laravel Package Development https://laravel.com/docs/packages
  → Relevant if you build modular UI5 apps as packages (e.g. in ui5/).

• Laravel Artisan Console https://laravel.com/docs/artisan
  → Useful when working with your custom ui5:* commands.

Open Data Protocol (OData)

• Official OData Site (OASIS) https://www.odata.org/
  → Intro, protocol specs, general understanding.

• OData v4 Specification https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html
  → Canonical source for query options, function imports, metadata formats.

• Microsoft OData Docs https://learn.microsoft.com/en-us/odata/
  → Tutorials, tooling, examples (often more accessible than the spec).

• Lodata https://lodata.io
  → Laravel OData v4 Package that underpins LaravelUi5's OData backend integration.