Skip to content
A code generation tool for Laravel developers.
PHP
Branch: master
Clone or download

README.md

Blueprint

A new open-source tool to rapidly generate multiple Laravel components using an expressive, human readable syntax.

Follow along with the development of Blueprint by watching live streams or reviewing issues.

v0.1 Tagged: A beta release of Blueprint is now available which supports generating components using models definitions.

Installation

You can install this package via composer using this command:

composer require --dev laravel-shift/blueprint

The package will automatically register itself.

Usage

Blueprint adds an artisan command.

php artisan blueprint:build [draft]

The draft file contains your definition of the components to generate. By default, the blueprint:build command automatically loads a draft.yaml file.


Example Syntax

models:
  Post:
    title: string:400
    content: longtext
    published_at: nullable timestamp

controllers:
  PostController:
    index:
      query: all posts
      render: post.index with posts

    store:
      validate: title, content
      save: post
      send: ReviewNotification to post.author
      queue: SyncMedia
      flash: post.title
      redirect: post.index

Generated Components

  • Migration
  • Model
  • Factory
  • Route
  • Controller
  • Form Request
  • Mailable
  • Job
  • View (stub)

Contributing

Contributions should be submitted to the master branch. Any submissions should be complete with tests and adhere to the PSR-2 code style. You may also contribute by opening an issue.

You can’t perform that action at this time.