README

Laravel Schematics

Warning

This project is no longer maintained.

Laravel Schematics is preserved as a historical open-source project. Compatibility with current Laravel versions is not maintained, and no support, security updates, or new releases are planned. You are welcome to fork the project under the terms of the MIT license.

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:

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 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:

/**
 * Laravel Schematics
 *
 * WARNING: removing @tag value will disable automated removal
 *
 * @package Laravel-schematics
 * @author  Maarten Tolhuijs <mtolhuys@protonmail.com>
 * @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:

composer test

Or, optionally, with coverage information:

composer test-coverage

Changelog

Please see CHANGELOG 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

Project status

This repository is kept available for reference and for existing users who may need to inspect its source. It no longer accepts support requests, bug fixes, feature requests, or security reports.

Do not use this package for new production projects. If you want to continue its development, please create a fork.

License

The MIT License (MIT). Please see License File for more information.

mtolhuys / laravel-schematics

Maintainers

Package info

Statistics

Security