escire-orlab/connect

连接 ORLAB 和 Proyecto Azul 的包

1.0.0 2024-01-22 15:55 UTC

This package is not auto-updated.

Last update: 2024-09-18 01:33:29 UTC


README

开始 🚀

以下说明将帮助您在开发环境中启动 Connect 包,以便开始使用它。

先决条件 📋

系统要求

  • PHP 8.1 或更高版本
  • Composer

安装 🔧

安装 Connect 包并编辑 CONNECT_KEY

执行: composer require escire-orlab/connect 在 ORLAB 和 Proyecto Azul 的项目中

然后在每个 .env 文件中定义一个名为 CONNECT_KEY 的连接键。您可以自定义应用程序的不同部分。

然后在 .env 文件中配置连接的网站,用逗号分隔,在属性 CONNECT_SITES=sitioa.com,sitiob.test,etc.com

只需放置连接的网站,但不要放置当前主机。

可选地,您还可以自定义重定向路径 CONNECT_REDIRECT_PATH,例如 CONNECT_REDIRECT_PATH="dashboard/path"

自定义发送连接请求的数据。

(可选) 首次自定义是数据的发送方式

\EscireOrlab\Connect\Helpers\ConfigHelper::$customConnectUrl = function ($user) {
    // Tu lógica personalizada aquí
    // Ej. 
    return $user->toJson();
};

自定义创建连接回调

(可选) 同样可以自定义 EscireOrlab\Connect\Services\CreateConnectionService::$customCreateConnectCallback,它自定义了保存用户操作。这应该返回 User 模型。

访问按钮

(必需) 在连接的网站上添加如下按钮

<div class="hidden space-x-8 sm:-my-px sm:ms-10 sm:flex">
    <x-nav-link 
        :href="route('orlab.connect.create', [
            'redirect_url' => 'http://connect_azul.test',
        ])" 
        :active="request()->routeIs('orlab.connect.create')">
        {{ __('Proyecto Azul') }}
    </x-nav-link>
</div>

redirect_url 必须指向要连接的网站。该网站应共享相同的 CONNECT_KEY 以正常工作,并且需要安装 escire-orlab/connect 包。

另一个要求是用 post 方法替换应用程序中的注销方法为 orlab.connect.close 路径。该路径除了关闭用户会话外,还将关闭连接的网站会话。例如

<form method="POST" action="{{ route('orlab.connect.close') }}">
    @csrf

    <x-dropdown-link :href="route('orlab.connect.close')"
            onclick="event.preventDefault();
                        this.closest('form').submit();">
        {{ __('Log Out') }}
    </x-dropdown-link>
</form>

运行测试 ⚙️

构建工具 🛠️

项目中使用的技术和工具列表

  • PHP
  • Laravel 10
  • Composer

版本控制 📌

项目使用 SemVer 版本控制系统,允许识别错误修正、新功能的实施以及重大更新。在这种情况下,我们将提供详细信息以执行相应的更新。

作者 ✒️

项目作者列表。

  • Homero Raul Vargas Cruz

许可证 📄

开发人员说明

TODO