Laravel Vibes

🚀 Laravel Vibes 文檔

Laravel Vibes 是一個為 Laravel 框架打造的實用工具集，能夠幫助開發者更高效地管理工具和資源，提升應用性能。以下是關於它的詳細使用說明。

🚀 快速開始

Laravel Vibes 提供了一系列實用工具和資源管理功能，幫助你快速搭建和優化 Laravel 應用。下面將介紹如何快速上手。

📦 安裝指南

1. 安裝 Laravel Vibes 包

使用 Composer 安裝 Laravel Vibes：

composer require projectsaturnstudios/laravel-vibes

2. 註冊服務提供者

在 config/app.php 文件中註冊 TheAgency 作為服務提供者：

'Projectsaturn\TheAgency\TheAgencyServiceProvider::class',

3. 發佈配置文件

運行以下命令將配置文件發佈到你的項目目錄：

php artisan vendor:publish --provider=Projectsaturn\TheAgency\TheAgencyServiceProvider

💻 使用示例

基礎用法

創建第一個 Vibe 工具

在 app/Tools 目錄下創建一個新的工具類，繼承自 VibeTool：

<?php

namespace App\Tools;

use Projectsaturn\Vibe\VibeTool;

class MyFirstTool extends VibeTool
{
    public function handle()
    {
        return "Hello, World!";
    }
}

在配置中註冊工具

在 config/vibes.php 文件中添加你的工具：

'App\Tools\MyFirstTool::class' => [
    'name' => 'my_first_tool',
],

使用 Vibe 工具

通過服務提供者訪問工具：

$vibe = $this->app->make('vibes');
$result = $vibe->runPrimitive(
    primitive: MyFirstTool::class,
    context: ['key' => 'value'],
    options: [
        'option1' => true,
        'option2' => 'string',
    ],
);

資源分配使用示例

創建資源

在 app/Resources 目錄下創建一個新的資源類：

<?php

namespace App\Resources;

use Projectsaturn\Vibe\Resource;

class MyResource extends Resource
{
    public function getPrimitive()
    {
        return 'my_resource_value';
    }
}

在配置中註冊資源

在 config/vibes.php 文件中添加你的資源：

'App\Resources\MyResource::class' => [
    'name' => 'my_resource',
],

📚 詳細文檔

📈 性能基準

為了確保最佳性能，我們建議進行以下基準測試：

1. 內存使用：監控應用的內存佔用，確保在高負載下不會超出限制。
2. 響應時間：測量每個 Vibe 工具的執行時間，優化關鍵路徑。
3. 吞吐量：測試每秒處理的最大請求數，確定擴展點。

📄 常見問題

1. 如何解決兼容性問題？

確保你的 Laravel 版本與 Laravel Vibes 兼容。查看 Compatibility Matrix 獲取更多信息。

2. 遇到了錯誤怎麼辦？

檢查日誌文件以獲取詳細錯誤信息，並參考 Troubleshooting Guide 解決常見問題。

📎 部署考量

1. 容器化部署

使用 Docker 進行容器化部署：

FROM php:8.0

COPY --from=composer:latest /usr/bin/composer /usr/bin/composer

WORKDIR /app
COPY . .

RUN composer install

CMD ["php", "artisan", "serve"]

2. 配置優化

在生產環境中啟用緩存和壓縮：

'view' => [
    'prerender' => true,
],
'render' => [
    'gzip' => true,
],

📋 路線圖

未來版本規劃

🔧 技術細節

🛠️ 架構概述

核心組件

1. TheAgency：負責管理所有 Vibe 工具和服務。
2. VibeTool：定義工具的基本接口和執行邏輯。
3. Resource：用於處理應用中的資源分配和管理。

執行流程

1. 初始化工具並注入依賴。
2. 處理輸入上下文和選項。
3. 返回結果或拋出異常。

📁 貢獻指南

1. 提交問題

在 GitHub 倉庫中提交 issue 報告問題或提出建議： GitHub Issues

2. 提交補丁

fork 倉庫，創建功能分支，並提交 pull request。

3. 贊助項目

如果你喜歡這個項目，請考慮贊助以支持我們的發展： Support via Patreon

📄 許可證

Laravel Vibes 由 MIT 許可證授權。查看 LICENSE 獲取詳細信息。

感謝使用 Laravel Vibes！如果有任何問題或建議，請隨時與我們聯繫。