{"id":13608354,"url":"https://github.com/beyondcode/laravel-er-diagram-generator","last_synced_at":"2025-05-12T15:25:55.156Z","repository":{"id":37677714,"uuid":"139572584","full_name":"beyondcode/laravel-er-diagram-generator","owner":"beyondcode","description":"Generate entity relation diagrams from your Laravel model files.","archived":false,"fork":false,"pushed_at":"2025-03-11T12:10:56.000Z","size":72,"stargazers_count":1973,"open_issues_count":19,"forks_count":199,"subscribers_count":33,"default_branch":"master","last_synced_at":"2025-05-08T04:36:53.125Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/beyondcode.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-03T11:19:19.000Z","updated_at":"2025-05-02T01:21:03.000Z","dependencies_parsed_at":"2023-10-20T18:13:10.689Z","dependency_job_id":"e306ec2f-3d32-47e3-b221-ddfb723ba9e6","html_url":"https://github.com/beyondcode/laravel-er-diagram-generator","commit_stats":{"total_commits":41,"total_committers":17,"mean_commits":2.411764705882353,"dds":0.6829268292682926,"last_synced_commit":"548a1f37ce27137682bf6286f87ad9e74c716659"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beyondcode%2Flaravel-er-diagram-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beyondcode%2Flaravel-er-diagram-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beyondcode%2Flaravel-er-diagram-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beyondcode%2Flaravel-er-diagram-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beyondcode","download_url":"https://codeload.github.com/beyondcode/laravel-er-diagram-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253480852,"owners_count":21915249,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T19:01:26.599Z","updated_at":"2025-05-12T15:25:55.123Z","avatar_url":"https://github.com/beyondcode.png","language":"PHP","funding_links":[],"categories":["PHP"],"sub_categories":[],"readme":"# Laravel ER Diagram Generator\n\n[![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)\n[![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)\n\nThis package lets you generate entity relation diagrams by inspecting the relationships defined in your model files.\nIt is highly customizable.\nBehind the scenes, it uses [GraphViz](https://www.graphviz.org) to generate the graph.\n\n\u003e 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.\n\n## Prerequisites\n\nThe minimum required PHP version is 7.1.0.\n\n## Requirements\n\nThis package requires the `graphviz` tool.\n\nYou can install Graphviz on MacOS via homebrew:\n\n```bash\nbrew install graphviz\n```\n\nOr, if you are using Homestead:\n\n```bash\nsudo apt-get install graphviz\n```\n\nTo install Graphviz on Windows, download it from the [official website](https://graphviz.gitlab.io/_pages/Download/Download_windows.html).\n\n## Installation\n\nYou can install the package via composer:\n\n```bash\ncomposer require beyondcode/laravel-er-diagram-generator --dev\n```\n\nIf you are using Laravel 5.5+, the package will automatically register the service provider for you.\n\nIf you are using Lumen, you will need to add the following to `bootstrap\\app.php`:\n\n```php\n# Register Service Providers\n$app-\u003eregister(BeyondCode\\ErdGenerator\\ErdGeneratorServiceProvider::class);\n```\n\n## Usage\n\nBy 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.\n\n```bash\nphp artisan vendor:publish --provider=BeyondCode\\\\ErdGenerator\\\\ErdGeneratorServiceProvider\n```\n\nIf you're using Lumen and you want to customize the config, you'll need to copy the config file from the vendor directory:\n\n```bash\ncp ./vendor/beyondcode/laravel-er-diagram-generator/config/config.php config/erd-generator.php\n```\n\n## Generating Diagrams\n\nYou can generate entity relation diagrams using the provided artisan command:\n\n```bash\nphp artisan generate:erd\n```\n\nThis will generate a file called `graph.png`.\n\nYou can also specify a custom filename:\n\n```bash\nphp artisan generate:erd output.png\n```\n\nOr use one of the other [output formats](https://www.graphviz.org/doc/info/output.html), like SVG:\n\n```bash\nphp artisan generate:erd output.svg --format=svg\n```\n\n## Customization\n\nPlease take a look at the published `erd-generator.php` configuration file for all available customization options.\n\n## Examples\n\nHere are some examples taken from the [Laravel.io](https://laravel.io) codebase.\n\n![Using Database Schema](https://beyondco.de/github/erd-generator/schema.png)\n\n![Customized](https://beyondco.de/github/erd-generator/customized.png)\n\n### Testing\n\n``` bash\ncomposer test\n```\n\n### Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n### Security\n\nIf you discover any security related issues, please email marcel@beyondco.de instead of using the issue tracker.\n\n## Credits\n\n- [Marcel Pociot](https://github.com/mpociot)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeyondcode%2Flaravel-er-diagram-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeyondcode%2Flaravel-er-diagram-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeyondcode%2Flaravel-er-diagram-generator/lists"}