northwestern-sysdev/er-diagram-tool

Automatically generate entity relationship diagrams for a Laravel application

v1.0.2 2024-02-06 22:40 UTC

This package is auto-updated.

Last update: 2024-04-06 22:56:52 UTC


README

Automatically generate interactive entity relationship diagram for models & their relationships in Laravel and emit a static HTML file for use in a VuePress site.

This package is a heavily-customized fork from kevincobain2000/laravel-erd meant for use in some very specific circumstances. If you're not part of @NIT-Administrative-Systems, you should probably check out the original package instead!

Installation

You can install the package via composer.

composer require northwestern-sysdev/er-diagram-tool --dev

Usage

You can generate a static HTML file with the artisan command:

php artisan erd:generate

This will be placed in docs/.vuepress/public/erd, or whatever path you have configured in config/laravel-erd.php.