Skip to content

Commit

Permalink
Correct outdated content
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonmccreary authored Feb 29, 2024
1 parent 34cc58c commit 421706a
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@

_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 and continue reading to get started.
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 the latest stable release of Laravel, currently Laravel 10.x.


## Installation
You can install Blueprint via composer using the following command:

Expand All @@ -22,18 +24,15 @@ composer require -W --dev laravel-shift/blueprint

Blueprint will automatically register itself using [package discovery](https://laravel.com/docs/packages#package-discovery).

_**Additional Configuration**: If you are running Laravel 8, or registering class-based routes or using the `app/Models` folder, you will need to configure Blueprint. Please review the [Blueprint Docs](https://blueprint.laravelshift.com/docs/advanced-configuration/) for additional guidance._

## Basic Usage
Blueprint comes with a set of artisan commands. The one you'll use the most is the `blueprint:build` command to generate the Laravel components:
Blueprint comes with a set of artisan commands. The one you'll 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 to generate some _blog_ components:
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:
Expand All @@ -59,7 +58,7 @@ controllers:
redirect: post.index
```
From these simple 20 lines of YAML, Blueprint will generate all of the following Laravel components:
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.
Expand All @@ -71,13 +70,17 @@ From these simple 20 lines of YAML, Blueprint will generate all of the following
- 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 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._

_**Note:** This example assumes features within a default Laravel application such as the `User` model and `app.blade.php` layout. Otherwise, the generated test 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 the latest stable version of Laravel (currently Laravel 9). If you need to support older versions of Laravel, you may use version 1 or upgrade your application ([try using Shift](https://laravelshift.com)).
Starting with version 2, Blueprint only generates code for the latest stable version of Laravel (currently Laravel 10). 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.

0 comments on commit 421706a

Please sign in to comment.