[appBuilder] 增加 readme 的快速开始模块 (#179)

Co-authored-by: wuayee <[email protected]>

Author: wuayee

README.md

@@ -1,6 +1,6 @@
 # AppPlatform
 
-**AppPlatform 是一个前沿的大模型应用工程，旨在通过集成的声明式编程和低代码配置工具，简化和优化大模型的训练与推理应用的开发过程。本工程为软件工程师和产品经理提供一个强大的、可扩展的环境，以支持从概念到部署的全流程 AI 应用开发。**
+**AppPlatform 是一个前沿的大模型应用工程，旨在通过集成的声明式编程和低代码配置工具，简化 AI 应用的开发过程。本工程为软件工程师和产品经理提供一个强大的、可扩展的环境，以支持从概念到部署的全流程 AI 应用开发。**
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/license/MIT)
 [![JDK](https://img.shields.io/badge/JDK-17-green.svg)](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
 [![Node](https://img.shields.io/badge/node-20-red.svg)](https://nodejs.org/en/download)
@@ -24,6 +24,25 @@
 3. **共享与协作**： AppPlatform 的底层包含 Store 模版，用于将所有开发的 AI 应用统一存储，以此支持跨项目的复用和协作。开发者可以根据需要组合这些应用，打造更大的解决方案，或者利用社区提供的工具和模型。在 AppPlatform 中， AI 应用不仅限于传统意义上的 “应用”，它们可以是 “函数”、“RAG”、“智能体”等任何可解释和可执行的组件。这些组件在 Store 中以 “工具” 的形式展现，其元数据不仅提供了必要的解释，还为智能体自动调度这些工具提供了基础。
 
 ---------
+
+## 安装数据库
+
+### Windows 系统
+
+- 下载并安装 [PostgresSQL](https://www.postgresql.org/download/)
+- 初始化数据。进入 `shell` 目录，使用 `bash` 工具执行 `build_win.sh`（当前不支持 `cmd` 执行，待规划）：
+
+```
+cd shell
+sh build_win.sh ${ip} ${port} ${username} ${password}
+```
+
+其中参数 ip、port、username、password 分别指的是数据库主机地址、数据库端口、数据用户名、数据库密码。该文件会初始化数据库内置数据，以及人工表单功能所需的数据。
+
+### Linux 系统
+
+待规划
+
 ## 后端环境配置
 
 开发环境配置
@@ -32,7 +51,7 @@
 - Java 17
 - 代码格式化文件：[CodeFormatterFromIdea.xml](CodeFormatterFromIdea.xml)
 - `Maven` 配置：推荐版本 Maven 3.8.8+
-- FIT 框架编译产物（链接待补充）
+- FIT 框架编译产物：参考 [FIT 框架](https://github.com/ModelEngine-Group/fit-framework) 的`环境配置`构建编译产物
 
 **构建命令**
 
@@ -52,6 +71,39 @@ build/
 
 > 后端模块基于 [FIT](https://ModelEngine-Group/fit-framework) 框架，启动方式采用了 [FIT 动态插件](https://github.com/ModelEngine-Group/fit-framework/blob/main/docs/framework/fit/java/quick-start-guide/03.%20%E4%BD%BF%E7%94%A8%E6%8F%92%E4%BB%B6%E7%9A%84%E7%83%AD%E6%8F%92%E6%8B%94%E8%83%BD%E5%8A%9B.md) 方式。
 
+打开框架输出目录的 `conf/fitframework.yml` 文件，找到如下配置项
+
+```yml
+fit:
+  beans:
+    packages:
+    - 'modelengine.fitframework'
+    - 'modelengine.fit'
+```
+
+加入数据库配置项，修改后的配置项如下所示：
+
+```yml
+fit:
+  beans:
+    packages:
+    - 'modelengine.fitframework'
+    - 'modelengine.fit'
+  datasource:
+     primary: 'sample-datasource' # 表示所选用的示例数据源。
+     instances:
+        sample-datasource:
+           mode: 'shared' # 表示该数据源的模式，可选共享(shared)或独占(exclusive)模式。
+           url: 'jdbc:postgresql://${ip}:${port}/' # 将 ip 换成数据库服务器的 ip 地址，将 port 换成数据库服务器监听的端口。
+           username: '${username}' # 将 username 替换为数据库的名称。
+           password: '${password}' # 将 password 替换为数据库的密码。
+           druid:
+              initialSize: ${initialSize} # 将 initialSize 替换为连接池的初始化连接数。
+              minIdle: ${midIdle} # 将 minIdle 替换为连接池的最小空闲连接数。
+              maxActive: ${maxActive} # 将 maxActive 替换为数据库连接池的最大活动连接数。
+              # 可根据具体需求，添加连接池所需配置项。
+```
+
 **启动命令**
 
 ```
@@ -70,7 +122,22 @@ fit start -Dfit.profiles.active=prod
 
 - 环境要求：node.js  >= 20
 
+- ELSA 框架编译产物：参考 ELSA 的编译构建章节（待补充）
+
+**修改 ELSA 依赖地址**
+
+进入目录 `app-engine\frontend` ，搜索 `package.json` 文件的 ELSA 依赖地址：
+
+```
+"dependencies": {
+    "@fit-elsa/elsa-core": "file:${fitElsaCoreUrl}",
+    "@fit-elsa/elsa-react": "file:${fitElsaReactUrl}",
+```
+
+将 `${fitElsaCoreUrl}` 和 `${fitElsaReactUrl}` 分别改成 `ELSA` 框架编译产物 `fit-elsa-core` 和 `fit-react` 的目录地址即可。
+
 **修改代理文件**
+
 修改 `AppPlatform/frontend` 目录下的 `proxy.config.json` 文件，可以修改需要访问的后端地址。如本地后端地址是 `http://127.0.0.1:8080` 。可以按照如下示例配置：
 
 ```json
@@ -89,13 +156,7 @@ fit start -Dfit.profiles.active=prod
 **依赖安装**
 
 ```
-cd framework/elsa/fit-elsa
-npm install
-npm run build:debug
-cd ../fit-elsa-react/
-npm install
-npm run build
-cd ../../../app-engine/frontend/
+cd app-engine/frontend/
 npm install
 ```
 
@@ -113,7 +174,19 @@ npm run start
 ---------
 ## 快速开始
 
-**待完善**
+**模型配置**
+
+在对话中使用大模型功能，需要对模型进行配置，包括大模型的地址和鉴权信息。
+首先在首页的`应用市场`一栏中找到 `模型配置应用`，并点击该应用。点击右上角`创意灵感` 的`开始配置`，如下图所示：
+![image-20250508203127410](doc\images\readme\model_config_inspiration.png)
+然后点击回答的 `添加模型` 按钮，输入模型名称、API Key 和模型地址，并点击确认。此时模型添加成功。
+
+**应用创建**
+
+在首页的`应用开发`一栏中点击`创建空白应用`。如下所示：
+![image-20250508204618312](doc\images\readme\app_create.png)
+输入所要创建的应用名称和简介，并点击 `创建`按钮，即可创建 AI 应用。接着在跳转后的应用配置页面上，在 `大模型` 一栏中选择自定义配置的模型。此时即可在对话框进行对话。如下所示：
+![image-20250508205124203](doc\images\readme\app_chat.png)
 
 ## 文档
 

app-engine/frontend/proxy.conf.json

@@ -4,7 +4,7 @@
     "secure": false,
     "changeOrigin": true,
     "pathRewrite": {
-      "^/api/jober": "/api/jober",
+      "^/api/jober": "",
       "^/api": ""
     }
   },
@@ -18,14 +18,14 @@
   },
   "/aippApi": {
     "target": "http://{ip}:{port}",
-    "pathRewrite": { "^/aippApi": "/api/jober/v1/api" },
+    "pathRewrite": { "^/aippApi": "/v1/api" },
     "secure": false,
     "changeOrigin": true
   },
   "/modelApi": {
     "target": "http://{ip}:{port}",
     "pathRewrite": {
-      "^/modelApi": "/api"
+      "^/modelApi": "/"
     },
     "secure": false,
     "changeOrigin": true

app-knowledge/plugins/knowledge-manager/src/main/resources/application.yml

@@ -26,4 +26,10 @@ fit:
           testOnBorrow: false
           testOnReturn: false
 mybatis:
-  mapper-locations: mapper/*Mapper.xml
+  mapper-locations: mapper/*Mapper.xml
+
+knowledge:
+  support-list:
+    - groupId: qianfanKnowledge
+      name: 百度千帆知识库
+      description: 百度千帆知识库

app-knowledge/plugins/knowledge-node-default/src/main/resources/application.yml

@@ -1,4 +1,7 @@
 fit:
   beans:
     packages:
-      - 'modelengine.jade.knowledge'
+      - 'modelengine.jade.knowledge'
+
+openai-urls:
+  internal: 'http://mock.com/'

doc/images/readme/app_chat.png

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+./sql_build.sh
+./sql_exec.sh "$@"
+
+current_dir=$(pwd)
+root_dir=$(echo $current_dir | cut -c 1-2)
+mkdir -p "${root_dir}"/var/share/smart_form
+
+cp -r ../examples/app-demo/normal-form/* "${root_dir}"/var/share/smart_form/
+cp -r ../examples/smart-form/* "${root_dir}"/var/share/smart_form/
+
+exit 0

doc/images/readme/app_create.png

@@ -0,0 +1,138 @@
+#!/bin/bash
+
+directory="../sql"  # 替换为实际目录路径
+
+# 创建目录（若不存在）
+mkdir -p "$directory"
+
+# 清空目录内容（仅在目录存在时执行）
+if [ -d "$directory" ]; then
+    find "$directory" -mindepth 1 -delete
+fi
+
+mkdir -p "$directory/schema"
+mkdir -p "$directory/data"
+
+# app plugin相关sql语句
+app_plugin_schema_sql_list=$(find ../app-builder/jane/plugins/aipp-plugin/src/main/resources/sql/schema -name "*.sql")
+echo "${app_plugin_schema_sql_list}"
+for i in ${app_plugin_schema_sql_list}
+do
+  cp "$i" "$directory/schema"
+done
+
+app_plugin_data_sql_list=$(find ../app-builder/jane/plugins/aipp-plugin/src/main/resources/sql/data -name "*.sql")
+echo "${app_plugin_data_sql_list}"
+for i in ${app_plugin_data_sql_list}
+do
+  cp "$i" "$directory/data"
+done
+
+# store相关sql语句
+store_schema_sql_list=$(find ../carver/plugins/tool-repository-postgresql/src/main/resources/sql/schema -name "*.sql")
+echo "${store_schema_sql_list}"
+for i in ${store_schema_sql_list}
+do
+  cp "$i" "$directory/schema"
+done
+
+store_schema_sql_list_task=$(find ../store/plugins/store-repository-postgresql/src/main/resources/sql/schema -name "*.sql")
+echo "${store_schema_sql_list_task}"
+for i in ${store_schema_sql_list_task}
+do
+  cp "$i" "$directory/schema"
+done
+
+store_data_sql_list_task=$(find ../store/plugins/store-repository-postgresql/src/main/resources/sql/data -name "*.sql")
+echo "${store_data_sql_list_task}"
+for i in ${store_data_sql_list_task}
+do
+  cp "$i" "$directory/data"
+done
+
+# app-engine-announcement 相关sql 脚本
+app_announcement_schema_sql_list=$(find ../app-engine/plugins/app-announcement/src/main/resources/sql/schema -name "*.sql")
+echo "${app_announcement_schema_sql_list}"
+for i in ${app_announcement_schema_sql_list}
+do
+  cp "$i" "$directory/schema"
+done
+
+# app-engine-metrics 相关sql 脚本
+app_metrics_schema_sql_list=$(find ../app-engine/plugins/app-metrics/src/main/resources/sql/schema -name "*.sql")
+echo "${app_metrics_schema_sql_list}"
+for i in ${app_metrics_schema_sql_list}
+do
+  cp "$i" "$directory/schema"
+done
+
+app_base_schema_sql_list=$(find ../app-engine/plugins/app-base/src/main/resources/sql/schema -name "*.sql")
+echo "${app_base_schema_sql_list}"
+for i in ${app_base_schema_sql_list}
+do
+  cp "$i" "$directory/schema"
+done
+
+# app-eval 相关 sql 脚本
+eval_dataset_schema_sql_list=$(find ../app-eval/plugins/eval-dataset/src/main/resources/sql/schema -name "*.sql")
+echo "${eval_dataset_schema_sql_list}"
+for i in ${eval_dataset_schema_sql_list}
+do
+  cp "$i" "$directory/schema"
+done
+
+eval_task_schema_sql_list=$(find ../app-eval/plugins/eval-task/src/main/resources/sql/schema -name "*.sql")
+echo "${eval_task_schema_sql_list}"
+for i in ${eval_task_schema_sql_list}
+do
+  cp "$i" "$directory/schema"
+done
+
+app_worker_schema_sql_list=$(find ../app-eval/plugins/simple-uid-generator/src/main/resources/sql/schema -name "*.sql")
+echo "${app_worker_schema_sql_list}"
+for i in ${app_worker_schema_sql_list}
+do
+  cp "$i" "$directory/schema"
+done
+
+# 自定义模型相关 sql 脚本
+app_model_center_schema_sql_list=$(find ../app-builder/plugins/aipp-custom-model-center/src/main/resources/sql/schema -name "*.sql")
+echo "${app_model_center_schema_sql_list}"
+for i in ${app_model_center_schema_sql_list}
+do
+  cp "$i" "$directory/schema"
+done
+
+app_model_center_data_sql_list=$(find ../app-builder/plugins/aipp-custom-model-center/src/main/resources/sql/data -name "*.sql")
+echo "${app_model_center_data_sql_list}"
+for i in ${app_model_center_data_sql_list}
+do
+  cp "$i" "$directory/data"
+done
+
+# 自定义知识库相关 sql 脚本
+app_knowledge_schema_sql_list=$(find ../app-knowledge/plugins/knowledge-manager/src/main/resources/sql/schema -name "*.sql")
+echo "${app_knowledge_schema_sql_list}"
+for i in ${app_knowledge_schema_sql_list}
+do
+  cp "$i" "$directory/schema"
+done
+
+app_knowledge_data_sql_list=$(find ../app-knowledge/plugins/knowledge-manager/src/main/resources/sql/data -name "*.sql")
+echo "${app_knowledge_data_sql_list}"
+for i in ${app_knowledge_data_sql_list}
+do
+  cp "$i" "$directory/data"
+done
+
+# wenjie 相关 sql 脚本
+app_wenjie_data_sql_list=$(find ../app-builder/plugins/plugins-show-case-parent/aito-data/src/main/resources/sql/data -name "*.sql")
+echo "${app_wenjie_data_sql_list}"
+for i in ${app_wenjie_data_sql_list}
+do
+  cp "$i" "$directory/data"
+done
+
+exit 0
+
+