README

This package provides Kanban board functionality for projects that use the Backpack for Laravel administration panel.

It adds a Kanban view to your CRUD panels, allowing you to visualize and manage your data in a Kanban-style board. This is particularly useful for tracking the status of items across different stages or categories.

Screenshots

Installation

You can install the package via composer:

composer require svenk/kanban-operation

Usage

To use the Kanban operation in your CrudController:

Use the KanbanOperation trait in your controller:

use Svenk\KanbanOperation\KanbanOperation;

class YourCrudController extends CrudController
{
    use KanbanOperation;

    // ...
}

Configure the Kanban board:

    protected function setupKanbanOperation()
    {
        CRUD::set('kanban.label_field', 'name'); //The field to display in the kanban card
        CRUD::set('kanban.column_field', 'status'); //The field to use as the column

        CRUD::setOperationSetting('columns', [
            'pending' => [
                'label' => 'Pending',
                'flow' => ['in_progress', 'backlog'], //The columns that can be moved to
            ],
            'in_progress' => [
                'label' => 'In Progress',
                'flow' => ['done', 'pending'],
            ],
            'done' => [
                'label' => 'Done',
                'flow' => null, //Can be moved to any column
            ],
        ]);
    }

This sets up a Kanban board with three columns (To Do, In Progress, Done), using the status field to determine which column an item belongs to, and the title field as the label for each item.

Customization

You can customize various aspects of the Kanban board:

Columns: Define your own columns and their labels.
Item Fields: Choose which model fields to use for the column and label.
Permissions: Control access to the Kanban view and item updates.

Change log

Please see the Releases tab for more information on what has changed recently.

Testing

composer test

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email sven.kolthof19@gmail.com instead of using the issue tracker.

Credits

License

This project was released under MIT, so you can install it on top of any Backpack & Laravel project. Please see the license file for more information.

However, please note that you do need Backpack installed, so you need to also abide by its YUMMY License. That means in production you'll need a Backpack license code. You can get a free one for non-commercial use (or a paid one for commercial use) on backpackforlaravel.com.

svenk / kanban-operation

Maintainers

Details