dreamfactory/package-installer

此软件包已被弃用且不再维护。未建议替代软件包。

DreamFactory 服务平台(tm)包安装程序

1.4.13 2015-06-11 16:19 UTC

README

Latest Stable Version Total Downloads Latest Unstable Version License

DreamFactory 平台包安装程序(PPI)是用于在您的 DSP 上安装应用程序、库和插件的工具。

使用此工具安装的软件包可免受系统升级的影响。

使用 Composer 打包

默认情况下,PPI 利用 DSP 使用的包管理器 Composer。虽然本文档和包安装程序需要 composer.json 文件来安装您的软件包,但 DSP 软件包不要求或限于使用此打包方法。有关替代打包方法的信息,请参阅 [Packaging Without Composer][]。

Composer 是什么?

Composer 是一个依赖项管理器,跟踪项目和库的本地依赖项。

有关更多信息,请参阅 https://getcomposer.org.cn/ 以及相关文档。

安装和用法

无需安装。若要使 PPI 安装您的软件包,您需要将 composer.json 属性 类型 设置为以下类型之一

  • dreamfactory-application
  • dreamfactory-library
  • dreamfactory-plugin

应用程序

应用程序是仅由客户端代码组成的 DSP 应用程序。这些应用程序安装在 DSP 的 /storage/applications 目录中。

插件/库

插件或库是 DSP 扩展,由代码或代码和 UI 组件组成。这些插件或库安装在 DSP 的 /storage/plugins 目录中。

指定您的软件包详细信息

除了指定软件包类型之外,PPI 还利用项目配置文件(composer.json)的“extra”部分。在此部分中,您可以自定义 DSP 软件包的安装

{
    "extra": {
    	"data":	{
    		"application":	{
				"api-name":                "pbox",
				"name":                    "Portal Sandbox",
				"description":             "A sample application that demonstrates the DSP's portal service.",
				"url":                     "/index.php",
				"is-url-external":         false,
				"import-url":              "https://github.com/dreamfactorysoftware/portal-sandbox/archive/master.zip",
				"is-active":               true,
				"requires-fullscreen":     false,
				"allow-fullscreen-toggle": true,
				"toggle-location":         "top"
		}
		"config":       "config/app.config.php",
		"links":        [
			{
				"target": "src/",
				"link":   "pbox"
			}
		]
	}
    }
}

在上面的示例中,我们为我们的软件包提供了一个漂亮的名字、一个 api_name(定义路由)和其他一些详细信息。

应用程序属性

名称 类型 描述
api-name 字符串 应用程序的 API 名称
名称 字符串 应用程序的显示名称
描述 字符串 应用程序的描述
is-active 布尔值 如果为 false,则应用程序由 DSP 忽略
url 字符串 指向此应用程序的绝对/相对 URL
is-url-external 布尔值 指示 URL 的来源
import-url 字符串 可以从中下载此应用程序的 URL
storage-service-id 整数 存储服务的 ID
storage-container 字符串 存储服务上存储此应用程序的容器
requires-fullscreen 布尔值 如果为 true,则全屏模式为默认
allow-fullscreen-toggle 布尔值 如果为 true,则可切换全屏模式
切换位置 字符串 切换的位置。默认为 "顶部"

不使用Composer进行打包

目前不可行。

贡献

所有代码贡献(包括有提交权限的人)必须通过拉取请求,并由核心开发者批准后才能合并。这是为了保证对所有代码的正确审查。

Fork 项目,创建一个功能分支,并发送拉取请求给我们。

如果您想查看 问题列表 以提供帮助。

社区

  • 加入我们的其他DSP用户,在 Google Groups 上!
  • IRC频道在irc.freenode.org上:#dreamfactory用于用户,#dreamfactory-dev用于开发。
  • Stack Overflow有越来越多的与DSP相关的 问题

许可

Composer根据Apache 2.0许可证授权 - 有关详细信息,请参阅LICENSE.txt文件