Phase 1

Author: ManukMinasyan

.github/FUNDING.yml

@@ -1 +1 @@
-github: :vendor_name
+github: Relaticle

.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +1,11 @@
 blank_issues_enabled: false
 contact_links:
   - name: Ask a question
-    url: https://github.com/:vendor_name/:package_name/discussions/new?category=q-a
+    url: https://github.com/Relaticle/flowforge/discussions/new?category=q-a
     about: Ask the community for help
   - name: Request a feature
-    url: https://github.com/:vendor_name/:package_name/discussions/new?category=ideas
+    url: https://github.com/Relaticle/flowforge/discussions/new?category=ideas
     about: Share ideas for new features
   - name: Report a security issue
-    url: https://github.com/:vendor_name/:package_name/security/policy
+    url: https://github.com/Relaticle/flowforge/security/policy
     about: Learn how to notify us for sensitive bugs

.github/SECURITY.md

@@ -1,3 +1,3 @@
 # Security Policy
 
-If you discover any security related issues, please email author@domain.com instead of using the issue tracker.
+If you discover any security related issues, please email manuk.minasyan1@gmail.com instead of using the issue tracker.

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-All notable changes to `:package_name` will be documented in this file.
+All notable changes to `flowforge` will be documented in this file.
 
 ## 1.0.0 - 202X-XX-XX
 

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) :vendor_name <author@domain.com>
+Copyright (c) Relaticle <manuk.minasyan1@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,61 +1,253 @@
-# :package_description
+# Flowforge - Kanban Board for Laravel and Filament
 
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
-[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/fix-php-code-styling.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3Amain)
-[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/relaticle/flowforge.svg?style=flat-square)](https://packagist.org/packages/relaticle/flowforge)
+[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/relaticle/flowforge/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/relaticle/flowforge/actions?query=workflow%3Arun-tests+branch%3Amain)
+[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/relaticle/flowforge/fix-php-code-styling.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/relaticle/flowforge/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3Amain)
+[![Total Downloads](https://img.shields.io/packagist/dt/relaticle/flowforge.svg?style=flat-square)](https://packagist.org/packages/relaticle/flowforge)
 
-<!--delete-->
----
-This repo can be used to scaffold a Filament plugin. Follow these steps to get started:
+Flowforge is a lightweight Kanban board package for Laravel 11 and Filament 3 that works with existing Eloquent models. This package allows developers to transform any model with a status field into a Kanban board with minimal configuration, without requiring additional database tables.
 
-1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
-2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
-3. Make something great!
----
-<!--/delete-->
+## Features
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+- Simple integration with existing Eloquent models
+- Drag-and-drop functionality between columns
+- Customizable card appearance
+- Filament 3 integration
+- Responsive design
+- Dark mode support
+- No additional database tables required
+
+## Requirements
+
+- PHP 8.1 or higher
+- Laravel 11.x
+- Filament 3.x
 
 ## Installation
 
 You can install the package via composer:
 
 ```bash
-composer require :vendor_slug/:package_slug
+composer require relaticle/flowforge
 ```
 
-You can publish and run the migrations with:
+The package will automatically register its service provider if you're using Laravel's package auto-discovery.
 
-```bash
-php artisan vendor:publish --tag=":package_slug-migrations"
-php artisan migrate
+## Usage
+
+### 1. Add the trait to your model
+
+Add the `HasKanbanBoard` trait to any Eloquent model you want to display on a Kanban board:
+
+```php
+use Relaticle\Flowforge\Traits\HasKanbanBoard;
+
+class Task extends Model
+{
+    use HasFactory;
+    use HasKanbanBoard;
+    
+    protected $fillable = [
+        'title',
+        'description',
+        'status',
+        'priority',
+        'due_date',
+    ];
+    
+    /**
+     * Get the status values for the task.
+     *
+     * @return array<string, string>
+     */
+    public static function getStatusOptions(): array
+    {
+        return [
+            'todo' => 'To Do',
+            'in_progress' => 'In Progress',
+            'review' => 'In Review',
+            'done' => 'Done',
+        ];
+    }
+}
 ```
 
-You can publish the config file with:
+### 2. Create a Kanban board page in your Filament resource
 
-```bash
-php artisan vendor:publish --tag=":package_slug-config"
+Create a new page that extends the `KanbanBoard` class:
+
+```php
+namespace App\Filament\Resources\TaskResource\Pages;
+
+use App\Filament\Resources\TaskResource;
+use App\Models\Task;
+use Relaticle\Flowforge\Filament\Resources\Pages\KanbanBoard;
+
+class TaskKanbanBoard extends KanbanBoard
+{
+    protected static string $resource = TaskResource::class;
+    
+    public function mount(): void
+    {
+        parent::mount();
+        
+        $this->statusField('status')
+            ->statusValues(Task::getStatusOptions())
+            ->titleAttribute('title')
+            ->descriptionAttribute('description')
+            ->cardAttributes([
+                'priority' => 'Priority',
+                'due_date' => 'Due Date',
+            ]);
+    }
+    
+    protected function getHeaderActions(): array
+    {
+        return [
+            \Filament\Actions\Action::make('back_to_list')
+                ->label('Back to List')
+                ->url(fn (): string => TaskResource::getUrl('index'))
+                ->icon('heroicon-o-arrow-left'),
+        ];
+    }
+}
 ```
 
-Optionally, you can publish the views using
+### 3. Register the Kanban board page in your resource
 
-```bash
-php artisan vendor:publish --tag=":package_slug-views"
+Add the Kanban board page to your resource's `getPages` method:
+
+```php
+public static function getPages(): array
+{
+    return [
+        'index' => Pages\ListTasks::route('/'),
+        'create' => Pages\CreateTask::route('/create'),
+        'edit' => Pages\EditTask::route('/{record}/edit'),
+        'kanban' => Pages\TaskKanbanBoard::route('/kanban'),
+    ];
+}
 ```
 
-This is the contents of the published config file:
+### 4. Add a link to the Kanban board in your resource's list page
+
+Add a header action to navigate to the Kanban board:
 
 ```php
-return [
-];
+protected function getHeaderActions(): array
+{
+    return [
+        Actions\CreateAction::make(),
+        Actions\Action::make('kanban')
+            ->label('Kanban Board')
+            ->url(fn (): string => TaskResource::getUrl('kanban'))
+            ->icon('heroicon-o-view-columns')
+            ->color('success'),
+    ];
+}
 ```
 
-## Usage
+## Advanced Usage
+
+### Standalone Kanban Board Page
+
+You can also create a standalone Kanban board page that's not tied to a specific resource:
+
+```php
+namespace App\Filament\Pages;
+
+use App\Models\Task;
+use Relaticle\Flowforge\Filament\Pages\KanbanBoardPage;
+
+class TasksKanbanBoard extends KanbanBoardPage
+{
+    protected static ?string $navigationIcon = 'heroicon-o-view-columns';
+    protected static ?string $navigationLabel = 'Tasks Kanban';
+    protected static ?string $title = 'Tasks Kanban Board';
+    
+    public function mount(): void
+    {
+        $this->adapter(Task::kanban(
+            'status',
+            Task::getStatusOptions(),
+            'title',
+            'description',
+            [
+                'priority' => 'Priority',
+                'due_date' => 'Due Date',
+            ]
+        ));
+        
+        parent::mount();
+    }
+}
+```
+
+### Custom Adapter
+
+You can create a custom adapter by implementing the `IKanbanAdapter` interface:
 
 ```php
-$variable = new VendorName\Skeleton();
-echo $variable->echoPhrase('Hello, VendorName!');
+namespace App\Kanban;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Collection;
+use Relaticle\Flowforge\Contracts\IKanbanAdapter;
+
+class CustomKanbanAdapter implements IKanbanAdapter
+{
+    protected Model $model;
+    protected string $statusField;
+    protected array $statusValues;
+    protected string $titleAttribute;
+    protected ?string $descriptionAttribute;
+    protected array $cardAttributes;
+    
+    public function __construct(
+        Model $model,
+        string $statusField,
+        array $statusValues,
+        string $titleAttribute,
+        ?string $descriptionAttribute = null,
+        array $cardAttributes = []
+    ) {
+        $this->model = $model;
+        $this->statusField = $statusField;
+        $this->statusValues = $statusValues;
+        $this->titleAttribute = $titleAttribute;
+        $this->descriptionAttribute = $descriptionAttribute;
+        $this->cardAttributes = $cardAttributes;
+    }
+    
+    // Implement the interface methods
+    // ...
+}
+```
+
+### Customizing the Card Appearance
+
+You can customize the appearance of the cards by publishing the views:
+
+```bash
+php artisan vendor:publish --tag="flowforge-views"
+```
+
+## Configuration
+
+You can publish the configuration file with:
+
+```bash
+php artisan vendor:publish --tag="flowforge-config"
+```
+
+This will publish a `flowforge.php` configuration file to your config directory.
+
+## Styling
+
+The package comes with default styling that integrates well with Filament's design system. You can customize the styling by publishing the CSS:
+
+```bash
+php artisan vendor:publish --tag="flowforge-assets"
 ```
 
 ## Testing
@@ -78,7 +270,7 @@ Please review [our security policy](../../security/policy) on how to report secu
 
 ## Credits
 
-- [:author_name](https://github.com/:author_username)
+- [manukminasyan](https://github.com/Relaticle)
 - [All Contributors](../../contributors)
 
 ## License

bin/build.js

@@ -46,5 +46,5 @@ const defaultOptions = {
 compile({
     ...defaultOptions,
     entryPoints: ['./resources/js/index.js'],
-    outfile: './resources/dist/skeleton.js',
+    outfile: './resources/dist/flowforge.js',
 })