README

laravel-mermaid-erd is a Laravel package that generates Entity-Relationship Diagrams (ERDs) using Mermaid.js from your database schema. It provides an easy-to-use command to visualize your database structure. This package is ideal for developers who need to document or understand their database relationships quickly.

Installation

You can install the package via composer:

composer require bambamboole/laravel-mermaid-erd

You can publish and run the migrations with:

php artisan vendor:publish --tag="laravel-mermaid-erd-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="laravel-mermaid-erd-config"

This is the contents of the published config file:

return [
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="laravel-mermaid-erd-views"

Usage

$laravelMermaidErd = new Bambamboole\LaravelMermaidErd();
echo $laravelMermaidErd->echoPhrase('Hello, Bambamboole!');

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

License

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

bambamboole / laravel-mermaid-erd

Maintainers

Details