diff --git a/README.md b/README.md index 4986f88..0ba96c9 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ -# EasyAI 远程组件项目 +# EasyAI 插件开发脚手架 ## 项目介绍 -本项目支持以插件的方式为EasyAI平台提供远程组件服务,以实现对EasyAI平台前端组件库进行扩展,实现自定义组件以满足业务需求。 +本项目支持以插件的方式为EasyAI平台提供组件服务,以实现对EasyAI平台前端组件库进行扩展,实现自定义组件以满足业务需求。 -## 功能描述 +## 功能描述和核心功能 -- 支持扩展绘画组件库 -- 支持扩展首页组件库 +- 支持扩展AI应用封装组件库。例如提示词、图像上传等各种组件,还可以访问自己的私有化数据库等 +- 支持扩展首页组件库。例如设计新的应用展示模块等其他各种功能。 - 支持应用引导组件库 +- typescript类型支持 ## 组件开发 @@ -50,7 +51,7 @@ pnpm dev }, ); ``` - + 3. 其他注入数据:用户信息、会员信息、具有权限的APP应用信息,公开的作品列表等 ## 示例组件 (图片上传组件) 1. 组件位置:components/drawPanne/ImageUpload.vue @@ -92,7 +93,7 @@ import { MockMaterials } from "~/composables/mock/material.data"; const materialData = ref(MockMaterials); /** - * EasyAI平台,已全局注入素材库库信息这里,使用mock数据用于调试 + * EasyAI平台,已全局注入素材库库信息这里,开发环境使用mock数据用于调试 */ provide(GlobalInjectKeyConst.AllMaterials, { materials: materialData, @@ -101,7 +102,7 @@ provide(GlobalInjectKeyConst.AllMaterials, { ``` -## 部署 +## 测试环境部署 1. 打包 @@ -121,7 +122,21 @@ pnpm serve http://localhost:3200 ``` +## 生产环境部署 +1. 打包 + +```bash +pnpm build +``` + +2. 复制构建产物目录`.output`,`pm2.config.js`到服务器 +3. 在服务器上安装node、pm2(具体安装方式请自行搜索) +4. 使用nginx代理项目/plugins/ 路由到项目端口`3020` + ## 使用 -- 维护 EasyAI 远程组件项目 +- 在EasyAI平台上使用插件(可以在应用设置-高级配置-应用详情页展示,搭建页面和自定义页面样式三个场景下使用插件) ![远程组件管理](./docs/images/RemoteComponentManage.png) + + +![应用使用指导详情页](docs/images/app-use-guide.png) \ No newline at end of file diff --git a/docs/images/app-use-guide.png b/docs/images/app-use-guide.png new file mode 100644 index 0000000..54b13a5 Binary files /dev/null and b/docs/images/app-use-guide.png differ