README

这是一个可用于开发新BIIGLE模块的模板。

如何开发BIIGLE模块

BIIGLE手册包含一些教程，可以帮助你开始BIIGLE模块开发。此存储库实现了前三个教程中涵盖的代码。

如何使用此模板

首先，基于此模板创建一个新的存储库。然后，将此模块的名称从 biigle/module 更改为你想要使用的任何名称。名称需要在以下位置进行更新

接下来，更新所有PHP类（Biigle\Modules\Module）的命名空间，并用你的模块名称替换 Module。同时，在 webpack.mix.js#L23 中也进行此操作。还要更新此README以适应你的新模块。你应该删除前两个小节，并更新安装说明。现在你可以安装此模块并开始开发。

除了教程中的代码之外，此存储库还包含了教程的配置，用于Laravel Mix作为构建系统。要安装构建系统，运行，然后运行 npm install。现在你可以使用以下命令

npm run dev：一次性构建和发布资源。
npm run prod：一次性构建、压缩并发布资源。在提交新代码之前，始终执行此操作。
npm run watch：每当资源文件更改时，持续构建和发布资源。
npm run lint：运行静态分析以检查错误。

安装

注意，你必须将 biigle/module 替换为你的模块/存储库的实际名称。

运行 composer require biigle/module。 这要求你的模块在 Packagist 上发布。如果你不想发布你的包，请参阅有关替代选项的更多信息。
将 Biigle\Modules\Module\ModuleServiceProvider::class 添加到 config/app.php 中的 providers 数组。将类命名空间中的 Module 替换为你的模块名称。
运行 php artisan vendor:publish --tag=public 以刷新模块的公共资源。每次更新此模块时都要这样做。

开发

查看核心存储库的开发指南以开始开发设置。

想要开发新模块？前往 biigle/module 模板存储库。

贡献和错误报告

欢迎为BIIGLE做出贡献。查看贡献指南以开始。

biigle / module

维护者

详细信息

README

如何开发BIIGLE模块

如何使用此模板

安装

开发

贡献和错误报告