Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andyabih/laravel-to-uml
Automagically generate UML diagrams of your Laravel code.
https://github.com/andyabih/laravel-to-uml
Last synced: about 2 months ago
JSON representation
Automagically generate UML diagrams of your Laravel code.
- Host: GitHub
- URL: https://github.com/andyabih/laravel-to-uml
- Owner: andyabih
- License: mit
- Created: 2021-04-04T14:54:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-21T22:56:26.000Z (over 1 year ago)
- Last Synced: 2024-07-10T17:02:16.151Z (2 months ago)
- Language: PHP
- Size: 43.9 KB
- Stars: 138
- Watchers: 4
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel UML Diagram Generator
Automagically generate UML diagrams of your Laravel code.
# Installation
To install LTU via composer, run the command:
```
composer require andyabih/laravel-to-uml --dev
```
# Usage
LTU will register the `/uml` route by default to a view that displays your UML graph.
You can configure the package and tweak it to fit your needs by publishing the config file using:
```
php artisan vendor:publish --provider="Andyabih\LaravelToUML\LaravelToUMLServiceProvider" --tag="config"
```
This will create a new `laravel-to-uml.php` file in your `config` folder.
# Configuration
The configuration should hopefully be self-explanatory. You can change what type of classes get included in the diagram by changing the `true|false` boolean in the configuration file.
You can also change the styling of the diagram in the config. LTU uses [nomnoml](https://github.com/skanaar/nomnoml) to generate the diagram, so more information about the different nomnoml styling properties can be found on their Github.
# Exporting the diagram
nomnoml generates the diagram in a canvas, and you can simply right click & save the canvas to an image.
# Importing requirements
Your classes must be imported using the `use` operator.
```php
// This will work and generate everything properly.
use App\Models\Post;
// Using it directly in the code without the use operator won't.
$posts = \App\Models\Post::all();
```
## Credits
- [Yellow Digital](https://yllwdigital.com)