A bridge between Laravel and Mermaid.

You can go both directions: Either scan your Laravel Application and generate a class diagram from it or pass an class diagram for code generation.

Generate Class Diagram

Laramaid will scan your Laravel Application and generate a Mermaid Class Diagram for it. This way your Diagram will always be up to date.

Github Action

Feel free to integrate the Laramaid Class-Diagram-Generator in your workflow. This ways you always get up to date diagrams that are part of version control.

Generate Laravel Boilerplate Code from your Class Diagram

Laramaid can generate boilerplate code from your mermaid class diagram: models, controllers, policies, enums, etc. It supports method-stub and property generation.

TBD:

Generate migration columns and factories

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require fase22/laramaid

You can publish and run the migrations with:

php artisan vendor:publish --tag="laramaid-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="laramaid-config"

This is the contents of the published config file:

return [
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="laramaid-views"

Usage

$laramaid = new Fase22\Laramaid();
echo $laramaid->echoPhrase('Hello, Fase22!');

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

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

Credits

• sebastianfaber
• All Contributors

License

The MIT License (MIT). Please see License File for more information.