Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laravel-shift/blueprint
A code generation tool for Laravel developers.
https://github.com/laravel-shift/blueprint
Last synced: 15 days ago
JSON representation
A code generation tool for Laravel developers.
- Host: GitHub
- URL: https://github.com/laravel-shift/blueprint
- Owner: laravel-shift
- License: mit
- Created: 2019-10-14T14:24:34.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-08T18:08:51.000Z (about 1 month ago)
- Last Synced: 2024-10-16T07:41:51.761Z (28 days ago)
- Language: PHP
- Homepage:
- Size: 1.26 MB
- Stars: 2,843
- Watchers: 50
- Forks: 272
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-laravel-filament - Laravel Shift Blueprint Generator
- awesome-laravel-filament - Laravel Shift Blueprint Generator
README
_Blueprint_ is an open-source tool for **rapidly generating multiple** Laravel components from a **single, human readable** definition.
Watch a quick [demo of Blueprint](https://www.youtube.com/watch?v=A_gUCwni_6c) in action or continue reading to get started.
## Requirements
Blueprint requires a Laravel application running a supported version of Laravel. Currently that is Laravel 10.38 or higher.
## Installation
You can install Blueprint via Composer using the following command:
```sh
composer require -W --dev laravel-shift/blueprint
```
Blueprint will automatically register itself using [package discovery](https://laravel.com/docs/packages#package-discovery).
If you wish to run the tests generated by Blueprint, you should also install the [Additional Assertions](https://github.com/jasonmccreary/laravel-test-assertions) package:
```sh
composer require --dev jasonmccreary/laravel-test-assertions
```
## Basic Usage
Blueprint comes with a set of artisan commands. The one you'll use to generate the Laravel components is the `blueprint:build` command:
```sh
php artisan blueprint:build [draft]
```
The _draft_ file contains a [definition of the components](https://blueprint.laravelshift.com/docs/generating-components/) to generate. Let's review the following example draft file which generates some _blog_ components:
```yaml
models:
Post:
title: string:400
content: longtext
published_at: nullable timestamp
author_id: id:user
controllers:
Post:
index:
query: all
render: post.index with:posts
store:
validate: title, content, author_id
save: post
send: ReviewPost to:post.author.email with:post
dispatch: SyncMedia with:post
fire: NewPost with:post
flash: post.title
redirect: posts.index
```
From these 20 lines of YAML, Blueprint will generate all of the following Laravel components:
- A _model_ class for `Post` complete with `fillable`, `casts`, and `dates` properties, as well as relationships methods.
- A _migration_ to create the `posts` table.
- A [_factory_](https://laravel.com/docs/database-testing) intelligently setting columns with fake data.
- A _controller_ class for `PostController` with `index` and `store` actions complete with code generated for each [statement](https://blueprint.laravelshift.com/docs/controller-statements/).
- _Routes_ for the `PostController` actions.
- A [_form request_](https://laravel.com/docs/validation#form-request-validation) of `StorePostRequest` validating `title` and `content` based on the `Post` model definition.
- A _mailable_ class for `ReviewPost` complete with a `post` property set through the _constructor_.
- A _job_ class for `SyncMedia` complete with a `post` property set through the _constructor_.
- An _event_ class for `NewPost` complete with a `post` property set through the _constructor_.
- A _Blade template_ of `post/index.blade.php` rendered by `PostController@index`.
- An [HTTP Test](https://laravel.com/docs/http-tests) for the `PostController`.
- A unit test for the `StorePostRequest` form request.
_**Note:** This example assumes features within a default Laravel application such as the `User` model and `app.blade.php` layout. Otherwise, the generated tests may have failures._
## Documentation
Browse the [Blueprint Docs](https://blueprint.laravelshift.com/) for full details on [defining models](https://blueprint.laravelshift.com/docs/defining-models/), [defining controllers](https://blueprint.laravelshift.com/docs/defining-controllers/), [advanced configuration](https://blueprint.laravelshift.com/docs/advanced-configuration/), and [extending Blueprint](https://blueprint.laravelshift.com/docs/extending-blueprint/).
## Support Policy
Starting with version 2, Blueprint only generates code for supported versions of Laravel (currently Laravel 10.38 or higher). If you need to support older versions of Laravel, you may use version 1 or upgrade your application ([try using Shift](https://laravelshift.com)).
Blueprint still follows [semantic versioning](https://semver.org/). However, it does so with respect to its grammar. Any changes to the grammar will increase its major version number. Otherwise, minor version number increases will contain new features. This includes generating code for future versions of Laravel.