https://github.com/recca0120/laravel-erd

Laravel ERD automatically generates Entity-Relationship Diagrams from your Laravel models and displays them using erd-editor.
https://github.com/recca0120/laravel-erd

Last synced: 24 days ago
JSON representation

Laravel ERD automatically generates Entity-Relationship Diagrams from your Laravel models and displays them using erd-editor.

• Host: GitHub
• URL: https://github.com/recca0120/laravel-erd
• Owner: recca0120
• License: mit
• Created: 2022-11-17T13:19:06.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-14T11:18:30.000Z (about 2 months ago)
• Last Synced: 2024-10-09T11:23:55.966Z (about 1 month ago)
• Language: PHP
• Homepage:
• Size: 1.56 MB
• Stars: 242
• Watchers: 6
• Forks: 9
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Laravel ERD

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

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/recca0120/laravel-erd/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/recca0120/laravel-erd/actions?query=workflow%3Arun-tests+branch%3Amain)

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

Laravel ERD automatically generates Entity-Relationship Diagrams from your Laravel models and displays them

using [erd-editor](https://github.com/dineug/erd-editor).

## Preview

Here's a sample of what you can expect, generated from [migrations](database/migrations)

and [models](tests/Fixtures/Models):

> [View Live Demo](https://rawcdn.githack.com/recca0120/laravel-erd/c936d64543139b70615333c833077a0076949dc8/demo/index.html)

![erd-editor](demo/erd-editor.png)

## Requirements

| Lang    | Version                 |

|:--------|:------------------------|

| PHP     | 7.4, 8.0, 8.1, 8.2, 8.3 |

| Laravel | 8, 9, 10, 11            |

## Installation

Install the package via Composer:

```bash

composer require recca0120/laravel-erd:^0.1 --dev

```

## Usage

### Step 1: Generate the ERD

Run the following command:

```bash

php artisan erd:generate

```

Step 2: View the ERD

Open the following URL in your browser:

http://localhost/laravel-erd

## Advanced Usage

### Exclude Tables and Save to a Different Filename

#### step 1.

Run the command:

```bash

php artisan erd:generate --file=exclude-users.sql --excludes=users

```

#### step 2.

Open the URL:

http://localhost/laravel-erd/exclude-users

### Generate an SVG Version

#### step 1.

Install [erd-go](https://github.com/kaishuu0123/erd-go)

and [graphviz-dot.js](https://github.com/kaishuu0123/graphviz-dot.js) using:

```bash

php artisan erd:install 

```

#### step 2.

Generate the SVG file:

```php

php artisan erd:generate --file=laravel-erd.svg

```

#### step 3.

View the SVG version:

http://localhost/laravel-erd/laravel-erd.svg

![svg](tests/Fixtures/expected_artisan.svg)

> The SVG file can be found at storage/framework/cache/laravel-erd.

Feel free to ask if you have any questions or need further assistance!