https://github.com/beyondcode/laravel-er-diagram-generator

Generate entity relation diagrams from your Laravel model files.
https://github.com/beyondcode/laravel-er-diagram-generator

Last synced: 6 days ago
JSON representation

Generate entity relation diagrams from your Laravel model files.

• Host: GitHub
• URL: https://github.com/beyondcode/laravel-er-diagram-generator
• Owner: beyondcode
• License: mit
• Created: 2018-07-03T11:19:19.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-15T17:41:08.000Z (8 months ago)
• Last Synced: 2024-10-31T22:35:09.916Z (13 days ago)
• Language: PHP
• Size: 69.3 KB
• Stars: 1,927
• Watchers: 35
• Forks: 191
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Laravel ER Diagram Generator

[![Latest Version on Packagist](https://img.shields.io/packagist/v/beyondcode/laravel-er-diagram-generator.svg?style=flat-square)](https://packagist.org/packages/beyondcode/laravel-er-diagram-generator)

[![Total Downloads](https://img.shields.io/packagist/dt/beyondcode/laravel-er-diagram-generator.svg?style=flat-square)](https://packagist.org/packages/beyondcode/laravel-er-diagram-generator)

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](https://www.graphviz.org) 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](https://phppackagedevelopment.com) 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:

```bash

brew install graphviz

```

Or, if you are using Homestead:

```bash

sudo apt-get install graphviz

```

To install Graphviz on Windows, download it from the [official website](https://graphviz.gitlab.io/_pages/Download/Download_windows.html).

## Installation

You can install the package via composer:

```bash

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`:

```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.

```bash

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:

```bash

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:

```bash

php artisan generate:erd

```

This will generate a file called `graph.png`.

You can also specify a custom filename:

```bash

php artisan generate:erd output.png

```

Or use one of the other [output formats](https://www.graphviz.org/doc/info/output.html), like SVG:

```bash

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](https://laravel.io) codebase.

![Using Database Schema](https://beyondco.de/github/erd-generator/schema.png)

![Customized](https://beyondco.de/github/erd-generator/customized.png)

### Testing

``` bash

composer test

```

### Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## Credits

- [Marcel Pociot](https://github.com/mpociot)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.