Download the PHP package schrojf/laravel-papers without Composer
On this page you can find all versions of the php package schrojf/laravel-papers. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download schrojf/laravel-papers
More information about schrojf/laravel-papers
Files in schrojf/laravel-papers
Package laravel-papers
Short Description Laravel papers package
License MIT
Homepage https://github.com/schrojf/laravel-papers
Informations about the package laravel-papers
Laravel Papers
⚠️ Experimental Package — Use With Caution
Laravel Papers is still in early development and considered experimental. While it is functional and may be used in production environments, please be aware of the following:
- The API is not stable and may change significantly in upcoming releases.
- Documentation may be incomplete or subject to improvement.
- Backward compatibility between minor versions is not guaranteed.
- Use at your own risk — review the source code and test thoroughly before deploying in critical systems.
Feedback, issues, and contributions are very welcome as the package evolves. If you're using it in production, consider locking to a specific version.
Laravel Papers is a lightweight and flexible package for building and displaying custom debug or reporting pages — called Papers — within your Laravel application. Each Paper can aggregate and display structured or unstructured data from various sources such as databases, services, or internal logic.
Originally created as an experimental project, Laravel Papers is ideal for internal tools, dashboards, and developer-oriented views that are simple to register and use.
Features
- Create dynamic reporting pages using reusable components
- Render structured data using tables and data panels
- Secure access using Laravel's Gate authorization
Requirements
- Laravel Framework 9.x, 10.x, 11.x, or 12.x
- PHP version 8.2, 8.3 or 8.4
- Modern web browser
Installation
Install the package via Composer:
Publish the configuration file (optional):
This is the default config/papers.php
file:
Publish the views (optional):
Usage
Registering Papers
Define and register your Paper classes in a service provider, such as AppServiceProvider.php
:
Access Control
By default, access to Papers is restricted in non-local environments. Define a Gate to control who can view them:
Creating a Paper
A Paper class extends Schrojf\Papers\Paper
and defines its sections as callable functions. Each section returns content such as strings, arrays, or component instances like TableContent
or DataPanelContent
.
Here’s a full example:
Testing
Run the test suite using:
Changelog
See CHANGELOG.md for a list of recent changes.
Contributing
Contributions are welcome! Please see CONTRIBUTING.md for guidelines.
Security Vulnerabilities
If you discover a security vulnerability, please review our security policy for how to responsibly report it.
Credits
- Viliam Schrojf
- All Contributors
License
This package is open-sourced software licensed under the MIT license.