diff --git a/src/platforms/quickapp/README.md b/src/platforms/quickapp/README.md index 7967202300e1432b25d59b2d2ccbfb5aa65b2753..94df19ba9013c2766088cc8380b792f2041b5cbd 100644 --- a/src/platforms/quickapp/README.md +++ b/src/platforms/quickapp/README.md @@ -1,7 +1,49 @@ -### 快应用适配教程 +## 快应用适配教程 +使用 uni-app 规范适配快应用 -#### 准备 +- uni-app文档 [https://uniapp.dcloud.io/](https://uniapp.dcloud.io/) +- 快应用文档 [https://doc.quickapp.cn/](https://doc.quickapp.cn/) + + +### 开发 + +1.Fork 仓库 `uni-app` [https://github.com/dcloudio/uni-app](https://github.com/dcloudio/uni-app),切换到 dev 分支 + +2.使用 Vue 规范开发组件,参考 `Button` 组件及 `clipboard` 示例 +``` +- button `src/platforms/quickapp/view/components/button` +- clipboard `src/platforms/quickapp/service/api/device/clipboard` +``` + +2.编译 (输出目录`packages/uni-quickapp`) +``` +npm run build:quickapp +``` + +#### `uni-app` 目录说明 + +``` +packages + ├─uni-quickapp + │ └─lib + │ ├─compiler-module (编译阶段标签转换之类逻辑) + │ ├─polyfill.css (全局样式差异代码) + │ └─manifest (manifest.json的生成逻辑) +src + ├─platforms + │ └─quickapp + │ ├─... + │ ├─service + │ │ └─api 平台的接口实现(方案同h5,app-plus) + │ └─view + │ └─components 平台的组件实现(easycom格式,目录名与文件名一致) + │ └─button +``` + +### 测试 + +#### 搭建测试环境 1.安装 [快应用调试器](https://statres.quickapp.cn/quickapp/quickapp/201806/file/quickapp_debugger.apk) @@ -9,16 +51,35 @@ 3.安装 openssl(windows系统) +#### 搭建测试工程 -#### 搭建 - -1.创建 `hello uni-app` 测试工程 +1.创建测试工程 (推荐使用空项目,可选 `hello uni-app` 工程,包含组件及API示例,工程较复杂编译比较耗时) ``` vue create -p dcloudio/uni-preset-vue#alpha my-qa-project -n ``` -目前手动安装依赖库: 根目录执行 ``` -yarn add @dcloudio/uni-quickapp@alpha -D + + + + + + ``` 2.生成证书 `certificate.pem` 和 `private.pem`:到目录 `src/sign/debug/` @@ -40,46 +101,10 @@ npm run serve:quickapp 6.修改代码后,会主动通知调试器更新,或者手动点击在线更新(调试可以点击右下角开始调试) +7.手动替换编译输出目录 `packages/uni-quickapp` 到测试工程 `node_modules/@dcloudio/uni-quickapp`, 可以考虑 `npm link` -#### 开发调试代码 - -1.Fork 仓库 `uni-app` [https://github.com/dcloudio/uni-app](https://github.com/dcloudio/uni-app),切换到 dev 分支 - -2.编译 (输出目录`packages/uni-quickapp`) - -``` -npm run build:quickapp -``` - -3.手动替换编译输出目录 `packages/uni-quickapp` 到测试工程 `node_modules/@dcloudio/uni-quickapp`,也可以考虑自己npm link本地`uni-quickapp`包(需要考虑三方依赖) - -4.使用 pull request 提交代码 - - -#### `uni-app` 目录说明 - -``` -packages - ├─uni-quickapp - │ └─lib - │ ├─compiler-module (编译阶段标签转换之类逻辑) - │ ├─polyfill.css (全局样式差异代码) - │ └─manifest (manifest.json的生成逻辑) -src - ├─platforms - │ └─quickapp - │ ├─... - │ ├─service - │ │ └─api 平台的接口实现(方案同h5,app-plus) - │ └─view - │ └─components 平台的组件实现(easycom格式,目录名与文件名一致) - │ └─button -``` - - -#### 开发示例 -- button 组件 `src/platforms/quickapp/view/components/button` -- clipboard API `src/platforms/quickapp/service/api/device/clipboard` +### 提交代码 +使用 `pull request` 提交代码