final touches

Author: algethamy

README.md

@@ -0,0 +1,49 @@
+# Workflow Resource Tool for Laravel Nova
+
+This package helps you to create workflow on your Nova application
+
+![screenshot](./diagram.png)
+
+![screenshot](./details.png)
+
+
+## Installation
+
+You can install the package in to a Laravel app that uses [Nova](https://nova.laravel.com) via composer:
+
+```bash
+composer require cammac/nova-workflow
+```
+
+Next, publish the config file
+
+```bash
+php artisan vendor:publish --tag  workflow
+```
+
+open `config/workflow.php` and define your workflow
+
+## Usage
+
+To display the workflow that are associated with a given Nova resource, you need to add the workflow Resource Tool to your resource.
+
+For example, in your `app/Nova/Order.php` file:
+
+```php
+public function fields(Request $request)
+{
+    return [
+        ID::make()->sortable(),
+
+        // Your other fields
+
+        Workflow::make('request')->onlyOnDetail() // request is the workflow name defined in workflow configuration file
+
+    ];
+}
+```
+
+This will automatically search possible transitions for the current status
+
+## License
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

config/workflow.php

@@ -1,46 +1,45 @@
 <?php
 
-use App\Request;
 
 return [
     'workflows' => [
 
-        'request' => [
-            'model'       => Request::class,
-            'column'      => 'status',
-            'states'      => [
+        'request' => [ // workflow name
+            'model'       => \App\Request::class, //workflow applied to this model
+            'column'      => 'status', // on this column
+            'states'      => [ // the possible statuses
                 'pending',
                 'escalated',
                 'approved',
                 'rejected',
             ],
+
             'transitions' => [
                 'Approve'  => [
                     'from'  => ['pending', 'escalated'],
                     'to'    => 'approved',
-                    'event' => \App\Events\RequestApproved::class,
+                    'event' => \App\Events\RequestApproved::class, // fire event
                 ],
                 'Escalate' => [
                     'from'         => ['pending'],
                     'to'           => 'escalated',
-                    'with_reasons' => 'escalation_note', // the column name
                 ],
                 'Reject'   => [
                     'from'         => ['pending', 'escalated'],
                     'to'           => 'rejected',
                     'with_reasons' => [ // to create a dropdown
                         'model'   => \App\RejectionReason::class,
                         'columns' => [
-                            'id'    => 'id',
-                            'label' => 'title',
+                            'id'    => 'id', // value of the option
+                            'label' => 'title', // option label
                         ],
                     ],
                 ],
 
-
                 'Back to My Employee' => [
                     'from' => ['escalated'],
                     'to'   => 'pending',
+                    'with_reasons' => 'escalation_note', // display a free textarea to write the comment on the this column name
                 ],
             ],
         ],

details.png

@@ -28,7 +28,7 @@ public function boot()
 
         $this->publishes([
             __DIR__.'/../config/workflow.php' => config_path('workflow.php'),
-        ], 'nova-config');
+        ], 'workflow');
     }
 
     /**