Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mtolhuys/laravel-schematics
A Laravel package making a diagram of your models, relations and the ability to build them with it
https://github.com/mtolhuys/laravel-schematics
diagrams drag drop explanation laravel schematics
Last synced: 21 days ago
JSON representation
A Laravel package making a diagram of your models, relations and the ability to build them with it
- Host: GitHub
- URL: https://github.com/mtolhuys/laravel-schematics
- Owner: mtolhuys
- License: mit
- Created: 2020-01-20T17:27:22.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T18:49:35.000Z (over 1 year ago)
- Last Synced: 2024-06-18T14:11:21.310Z (23 days ago)
- Topics: diagrams, drag, drop, explanation, laravel, schematics
- Language: Vue
- Homepage:
- Size: 9.22 MB
- Stars: 1,488
- Watchers: 32
- Forks: 133
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Lists
- awesome-dev-with-laravel - - Make multiple diagrams of your Eloquent models and their relations. (Tools / Todo)
- docsify-awesome-stars - mtolhuys/laravel-schematics - A Laravel package making a diagram of your models, relations and the ability to build them with it (Vue)
- awesome-stars - laravel-schematics
- awesome-jekyll - mtolhuys/laravel-schematics - A Laravel package making a diagram of your models, relations and the ability to build them with it (Vue)
- awesome-stars - mtolhuys/laravel-schematics - A Laravel package making a diagram of your models, relations and the ability to build them with it (Vue)
README
Laravel Schematics
[](https://packagist.org/packages/mtolhuys/laravel-schematics)
[](https://travis-ci.org/mtolhuys/laravel-schematics)
[](https://scrutinizer-ci.com/g/mtolhuys/laravel-schematics)
[](https://packagist.org/packages/mtolhuys/laravel-schematics)
This package allows you to make multiple **diagrams** of your Eloquent **models** and their **relations**.
It will help building them providing drag and drop relations, forms to **create** and **edit** your models and many options like
adding **resource controllers**, **form requests** and running **migrations** by the click of a button or (configurable) automatically.
It also will give you insights in the migrations you ran and the ones specified in your migrations folder.
Its aim is to help you (and your team) get more grip on the models from a code perspective,
the status of your migrations and build / edit them faster.
---
## Installation
You can install the package via composer:
```bash
composer require mtolhuys/laravel-schematics --dev
```
Run `php artisan schematics:install` which will do the route caching, create vendor assets in your public folder and
setup the configuration file.
Or...
```php
php artisan vendor:publish --provider="Mtolhuys\LaravelSchematics\LaravelSchematicsServiceProvider"
```
and visit `{your-app}/schematics`
---
## Usage
#### Starting out / Searching
If you already have a lot of models I recommend you use the search bar to narrow down the diagrams into
specific sections f.e:
These searches are saved across your diagrams.
#### Relations
When you drag and drop the arrow to another model you'll get a form to specify the relation you want to build f.e:
Clicking on them will show something like:
#### Building / Editing Models
To specify the types of your columns I've chosen the form request rule syntax.
To see what's available you can click the little help icon below the fields in the model form:
The package is flexible enough to differentiate between renaming and changing column types.
It will create migrations according the need to change or create a table and setup your `$fillables`.
I do **strongly** suggest you check the migrations before running them if the stakes are high.
You don't have to worry about existing migrations though, the package will only look for migrations it created itself
by checking the value of the `@tag` in the comment it adds. It looks like this:
```php
/**
* Laravel Schematics
*
* WARNING: removing @tag value will disable automated removal
*
* @package Laravel-schematics
* @author Maarten Tolhuijs
* @url https://github.com/mtolhuys/laravel-schematics
* @tag laravel-schematics-foobar-model
*/
```
#### Changing Diagram Style
There are 4 diagram styles. Bezier, Straight, Flowchart and State Machine:
#### Importing / Exporting Diagrams
To save and / or share the diagrams you created you can use the export and import settings feature:
---
### Testing
You can run the tests with:
```bash
composer test
```
Or, optionally, with coverage information:
```bash
composer test-coverage
```
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Credits
This package is possible because of the effort and time of these people! ✨
Maarten Tolhuijs
Creator️
Deisi Tolhuijs
Design
Dennis Mwea
Contributor
Robbin Schepers
Contributor
Bram van Rijswijk
Support
Lucas Snel
Contributor
## Contributing
Since I'm getting some questions about this I want these things to be perfectly clear:
- This is a **safe** haven for contributions, every (positive) contributon matters!
- You are free (and encouraged) to use **anything** of this package for your own ideas.
- You can **always** ask for help or email me directly for any questions.
Please see [CONTRIBUTING](CONTRIBUTING.md) for further details.
### Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.