README

Official Documentation

Documentation for the framework can be found in the Wiki section and in https://macropay-solutions.github.io/maravel-docs.

AI-Friendly Framework

Maravel ships with a pre-configured .cursorrules file in the root directory. If you are using Cursor, Copilot, or Claude, your AI assistant already knows exactly how to generate resources, map routes, and write MaravelQL queries.

Contributing

We plan to not change the code that often in the maravel-framework package and allow you to build packages that use the DI container to extend functionality and also allow retroactive bug fixing.

We remain open for suggestions in the discussions area: https://github.com/macropay-solutions/maravel-framework/discussions

Notes:

We improved this template vs Lumen 10.0.4 template with:

route:{cache|clear} command

config:{cache|clear} command

event:{cache|clear} command that includes also observers

autowiring:{cache|clear} command

We striped down optional packages by adding them to composer.json autoload.exclude-from-classmap and commenting their bindings in \App\Application::$availableBindings and aliases in \App\Application::registerContainerAliases. Remove and uncomment them from there if/when you will need them.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

Maravel is open-sourced software licensed under the MIT license.