kouloughliapp/announcements

Kouloughli 的公告插件

v1.0.3 2020-01-31 13:43 UTC

This package is auto-updated.

Last update: 2024-09-06 03:21:29 UTC


README

📢 Kouloughli - 高级 PHP 登录和用户管理系统 的公告插件

安装

此插件需要 Kouloughli 4.0.0 或更高版本。

通过 Composer 安装

要安装此插件,首先您需要通过运行以下命令使用 composer 拉取它:

composer require Kouloughliapp/announcements

Composer 将为您安装插件以及其依赖项。

下一步是将插件注册到 KouloughliServiceProvider 中的 Kouloughli 插件列表,添加 \Kouloughli\Announcements\Announcements::class

protected function plugins()
    {
        return [
            //...
            \Kouloughli\Announcements\Announcements::class,
        ];
    }

一旦您的插件注册成功,您应该通过运行以下命令发布插件的静态资源和迁移:

php artisan vendor:publish --provider="Kouloughli\Announcements\Announcements" --tag="public" --tag="migrations"

作为安装的最后一步,您需要运行以下命令以进行所有必要的数据库修改:

php artisan migrate
php artisan db:seed --class="AnnouncementsDatabaseSeeder"

此时,插件将完全安装并准备好使用。

手动安装

如果您计划对插件进行修改并定制以适应您的需求,将其手动添加到项目中会更容易。

为此,您需要通过点击绿色“克隆或下载”按钮并从下拉菜单中选择“下载 ZIP”选项,从 GitHub 下载 ZIP 存档。

一旦您在计算机上有了 ZIP 文件,将其解压缩到 plugins/Announcements 文件夹中(您需要创建此文件夹,因为它可能不在您的 Kouloughli 安装中)。

下一步是更新位于 Kouloughli 根目录中的主 composer.json 文件,并将以下对象添加到 repositories 数组中:

{
    "type": "path",
    "url": "./plugins/Announcements"
}

这将告诉 composer,您的插件位于 /plugins/Announcements 目录中,并且应该从那里安装。

现在,将以下内容添加到 composer 的 require 部分:

"Kouloughliapp/announcements": "*"

然后运行 composer update

Composer 现在将从您的本地目录安装插件,而不是从 GitHub 拉取,这意味着您将能够修改插件本身并对其进行定制以适应您的需求。

其余的过程与通过直接从 GitHub 仓库通过 composer 获取插件相同,因此您需要执行上述所有相同步骤,简而言之,涉及更新 KouloughliServiceProvider 并运行发布插件静态资源和更新数据库的命令。

许可证

此插件是开源软件,根据 MIT 许可证 授权。