beyondcode/laravel-er-diagram-generator

Generate ER diagrams from your Laravel models.

Laravel ER Diagram Generator

, _(*1)

This package lets you generate entity relation diagrams by inspecting the relationships defined in your model files. It is highly customizable. Behind the scenes, it uses GraphViz to generate the graph., _(*2)

If you want to learn how to create reusable PHP packages yourself, take a look at my upcoming PHP Package Development video course., _(*3)

Prerequisites

The minimum required PHP version is 7.1.0., _(*4)

Requirements

This package requires the graphviz tool., _(*5)

You can install Graphviz on MacOS via homebrew:, _(*6)

brew install graphviz

Or, if you are using Homestead:, _(*7)

sudo apt-get install graphviz

To install Graphviz on Windows, download it from the official website., _(*8)

Installation

You can install the package via composer:, _(*9)

composer require beyondcode/laravel-er-diagram-generator --dev

If you are using Laravel 5.5+, the package will automatically register the service provider for you., _(*10)

If you are using Lumen, you will need to add the following to bootstrap\app.php:, _(*11)

# Register Service Providers
$app->register(BeyondCode\ErdGenerator\ErdGeneratorServiceProvider::class);

Usage

By default, the package will automatically detect all models in your app/Models directory that extend the Eloquent Model class. If you would like you explicitly define where your models are located, you can publish the configuration file using the following command., _(*12)

php artisan vendor:publish --provider=BeyondCode\\ErdGenerator\\ErdGeneratorServiceProvider

If you're using Lumen and you want to customize the config, you'll need to copy the config file from the vendor directory:, _(*13)

cp ./vendor/beyondcode/laravel-er-diagram-generator/config/config.php config/erd-generator.php

Generating Diagrams

You can generate entity relation diagrams using the provided artisan command:, _(*14)

php artisan generate:erd

This will generate a file called graph.png., _(*15)

You can also specify a custom filename:, _(*16)

php artisan generate:erd output.png

Or use one of the other output formats, like SVG:, _(*17)

php artisan generate:erd output.svg --format=svg

Customization

Please take a look at the published erd-generator.php configuration file for all available customization options., _(*18)

Examples

Here are some examples taken from the Laravel.io codebase., _(*19)

, _(*20)

, _(*21)

Testing

bash composer test, _(*22)

Changelog

Please see CHANGELOG for more information what has changed recently., _(*23)

Contributing

Please see CONTRIBUTING for details., _(*24)

Security

If you discover any security related issues, please email marcel@beyondco.de instead of using the issue tracker., _(*25)

Credits

• Marcel Pociot
• All Contributors

License

The MIT License (MIT). Please see License File for more information., _(*26)