Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
recca0120 committed Aug 25, 2024
1 parent 03399b1 commit fb0dc43
Show file tree
Hide file tree
Showing 5 changed files with 109 additions and 1 deletion.
9 changes: 9 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
* text=auto

/.github export-ignore
/screenshot export-ignore
/tests export-ignore
.editorconfig export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.nitpick.json export-ignore
27 changes: 27 additions & 0 deletions .github/workflows/fix-php-code-styling.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: "Fix PHP Code Styling"

on:
push:
paths:
- '**.php'

permissions:
contents: write

jobs:
php-code-styling:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}

- name: Fix PHP code style issues
uses: aglipanci/laravel-pint-action@2.4

- name: Commit changes
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: Fix styling
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Tests
name: run-tests

on: [ push ]

Expand Down
72 changes: 72 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# 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)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/recca0120/laravel-erd/fix-php-code-styling.yml?branch=main&label=code%20styling&style=flat-square)](https://github.com/recca0120/laravel-erd/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/recca0120/laravel-erd.svg?style=flat-square)](https://packagist.org/packages/recca0120/laravel-erd)

Automatically generate ERD from Laravel Models, and show ERD by [Vuerd](https://github.com/dineug/erd-editor)

## Preview

this preview is generated from [migrations](database/migrations) and [models](tests/fixtures/Models)

![Vuerd](screenshot/vuerd.jpg)

## Requirements

| Lang | Version |
|:--------|:------------------------|
| PHP | 7.4, 8.0, 8.1, 8.2, 8.3 |
| Laravel | 8, 9, 10, 11 |

## Installation

You can install the package via composer:

```bash
composer require recca0120/laravel-erd --dev
```

## Usage

#### step 1.

generate erd

```bash
php artisan erd:generate
```

#### step 2.

open url

http://localhost/laravel-erd

## Advanced

### If you want generate svg version you can

#### step 1.

you can execute this command to install [erd-go](https://github.com/kaishuu0123/erd-go)
and [graphviz-dot.js](https://github.com/kaishuu0123/graphviz-dot.js)

```bash
php artisan erd:install
```

#### step 2.

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

#### step 3.

open url http://localhost/laravel-erd/laravel-erd.svg, you will see a svg version

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

or you will find laravel-erd.svg in folder storage/framework/cache/laravel-erd
Binary file added screenshot/vuerd.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fb0dc43

Please sign in to comment.