beyondcode / laravel-er-diagram-generator
Generate ER diagrams from your Laravel models.
Installs: 1 101 691
Dependents: 2
Suggesters: 0
Security: 0
Stars: 1 930
Watchers: 35
Forks: 191
Open Issues: 18
Requires
- php: ^7.1|^8.0
- doctrine/dbal: ~2.3|^3.3
- nikic/php-parser: ^2.0|^3.0|^4.0|^5.0
- phpdocumentor/graphviz: ^1.0
Requires (Dev)
- larapack/dd: ^1.0
- orchestra/testbench: ~3.5|~3.6|~3.7|~3.8|^4.0|^7.0|^8.0|^9.0
- phpunit/phpunit: ^7.0| ^8.0|^9.5.10
- spatie/phpunit-snapshot-assertions: ^1.3|^4.2
README
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.
If you want to learn how to create reusable PHP packages yourself, take a look at my upcoming PHP Package Development video course.
Prerequisites
The minimum required PHP version is 7.1.0.
Requirements
This package requires the graphviz
tool.
You can install Graphviz on MacOS via homebrew:
brew install graphviz
Or, if you are using Homestead:
sudo apt-get install graphviz
To install Graphviz on Windows, download it from the official website.
Installation
You can install the package via composer:
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.
If you are using Lumen, you will need to add the following to bootstrap\app.php
:
# 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.
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:
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:
php artisan generate:erd
This will generate a file called graph.png
.
You can also specify a custom filename:
php artisan generate:erd output.png
Or use one of the other output formats, like SVG:
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.
Examples
Here are some examples taken from the Laravel.io codebase.
Testing
composer test
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email marcel@beyondco.de instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.