Blueprint

https://github.com/laravel-shift/blueprint

Admin

Blueprint is an open-source tool for rapidly generating multiple Laravel components from a single,...

Tokens:1,736

Snippets:15

Trust Score:8.9

License:MIT

Update:1 month ago

Show doc for...

Tokens:

Raw

### Install Additional Assertions package

Source: https://github.com/laravel-shift/blueprint/blob/master/README.md

Install the Additional Assertions package to run tests generated by Blueprint. This is required for the generated tests to pass.

```sh
composer require --dev jasonmccreary/laravel-test-assertions
```

--------------------------------

### Example draft file for generating blog components

Source: https://github.com/laravel-shift/blueprint/blob/master/README.md

This YAML draft file defines a Post model and PostController with index and store actions. From these 20 lines, Blueprint generates a model, migration, factory, controller, routes, form request, mailable, job, event, Blade template, and tests. The example assumes default Laravel features like the User model and app.blade.php layout.

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

--------------------------------

### Install Blueprint via Composer

Source: https://github.com/laravel-shift/blueprint/blob/master/README.md

Install Blueprint as a dev dependency using Composer. The -W flag also updates dependencies. Blueprint auto-registers via package discovery.

```sh
composer require -W --dev laravel-shift/blueprint
```

--------------------------------

### Run blueprint:build artisan command

Source: https://github.com/laravel-shift/blueprint/blob/master/README.md

Run the blueprint:build artisan command to generate Laravel components from the draft file. This is the primary command used to generate components.

```sh
php artisan blueprint:build
```

Tokens:

Raw