Explorar o código

docs(README): 更新文档以支持模块独立开发和发布

- 添加开发环境设置指南,包括作为独立模块开发的步骤
- 补充模块安装、启用、迁移和种子命令说明
- 新增发布模块到 Packagist 的步骤
- 更新 composer.json 文件,将类型改为 laravel-module
dongasai hai 5 meses
pai
achega
ea69346778
Modificáronse 3 ficheiros con 59 adicións e 1 borrados
  1. 45 0
      README.md
  2. 1 1
      composer.json
  3. 13 0
      module.json

+ 45 - 0
README.md

@@ -31,12 +31,57 @@ php artisan vendor:publish --tag=madmindemo-config
 - 配置管理
 - 测试支持
 
+## 开发环境设置
+
+### 作为独立模块开发
+
+如果您想将此模块作为独立的 Laravel 模块进行开发:
+
+1. 创建一个新的 Laravel 项目
+2. 安装 Laravel Modules 包:
+   ```bash
+   composer require nwidart/laravel-modules
+   ```
+3. 安装 laravel-module-installer 插件,确保模块安装到 `Modules/` 目录:
+   ```bash
+   composer require joshbrw/laravel-module-installer
+   ```
+
+### 模块安装
+
+在您的 Laravel 项目中安装此模块:
+
+```bash
+composer require dcatadmin2/module-dcatadmin_demo
+```
+
+### 启用模块
+
+```bash
+php artisan module:enable dcatadmindemo
+```
+
+### 运行迁移和种子
+
+```bash
+php artisan module:migrate dcatadmindemo
+php artisan module:seed dcatadmindemo
+```
+
 ## 测试
 
 ```bash
 composer test
 ```
 
+## 发布模块
+
+如果您想将此模块发布到 Packagist 供其他开发者使用:
+
+1. 确保 `composer.json` 中的 `type` 设置为 `laravel-module`
+2. 将模块推送到 GitHub,仓库名格式为 `dcatadmin-demo-module`
+3. 在 [Packagist](https://packagist.org) 上提交您的模块
+
 ## 更新日志
 
 请查看 [CHANGELOG](CHANGELOG.md) 了解最近更新的详细信息。

+ 1 - 1
composer.json

@@ -1,7 +1,7 @@
 {
     "name": "dcatadmin2/module-dcatadmin_demo",
     "description": "Dcat Admin Demo Module - A comprehensive demonstration module for Dcat Admin",
-    "type": "library",
+    "type": "laravel-module",
     "keywords": ["laravel", "dcat-admin", "module", "demo"],
     "license": "MIT",
     "authors": [

+ 13 - 0
module.json

@@ -0,0 +1,13 @@
+{
+    "name": "DcatAdminDemo",
+    "alias": "dcat-admin-demo",
+    "description": "Dcat Admin Demo Module - A comprehensive demonstration module for Dcat Admin",
+    "keywords": ["laravel", "dcat-admin", "module", "demo"],
+    "priority": 1,
+    "providers": [
+        "DcatAdminDemo\\Providers\\MAdminDemoServiceProvider"
+    ],
+    "aliases": {},
+    "files": [],
+    "requires": []
+}