优化开发环境搭建文档

Author: Andyguo5891

docs/dev_manual/dev_environment.md

@@ -23,42 +23,51 @@
     ├── pyproject.toml          # 后端依赖 配置文件         
     └── ui                      # 前端项目根目录          
     ├── config_example.yml      # 项目配置示例             
-    ├── main.py                 # 项目入口文件 python main.py start 启动项目             
+    ├── main.py                 # 项目入口文件              
     ```     
 
 ## 2 环境准备          
 
 !!! Abstract "" 
     - **前端环境准备**       
-      安装 [node](https://nodejs.org/)      
+      安装 [node](https://nodejs.org/) ，v16及以上版本     
     - **后端环境准备**        
-      安装 [python](https://www.python.org/downloads/release/python-3115/)        
+      安装 [python](https://www.python.org/downloads/release/python-3115/) ，版本 v3.11.x  
       安装 [pycharm](https://www.jetbrains.com/pycharm/download/)
+    - **数据库**   
+      安装 [PostgreSql](https://www.postgresql.org/) ，版本 v15.x
 
-## 3 开发环境搭建
+## 3 本地配置
+
+### 3.1 创建数据库
 
 !!! Abstract "" 
-    安装 poetry 包管理器
-    ``` bash
-    pip install poetry
+    在 PostgreSql 中手动创建MaxKB 应用数据库，名称为`maxkb`。
+    ```
+    # 创建数据库
+    CREATE DATABASE "maxkb"; 
+    # 切换使用数据库
+    \c "maxkb"; 
+    # 创建vector 扩展
+    CREATE EXTENSION "vector";
     ```
 
-## 4 本地配置
+### 3.2 配置文件
 
 !!! Abstract "" 
       项目启动之前，需要准备配置文件及目录
 
       - 准备配置文件
 
       ```bash
-      # 将config_example.yml配置文件 目录拷贝至 /opt/maxkb/conf目录下 如果是Windows D:\\opt\\maxkb\\conf
+      # 将config_example.yml配置文件拷贝至 /opt/maxkb/conf目录下
       cp config_example.yml /opt/maxkb/conf
       ```
 
       - 配置 /opt/maxkb/conf/config_example.yml 
 
       ```
-      # 数据库配置 
+      # 数据库配置（将以下信息替换为实际环境信息）
       DB_NAME: maxkb
       DB_HOST: localhost
       DB_PORT: 5432
@@ -73,74 +82,70 @@
       EMBEDDING_MODEL_NAME: /opt/maxkb/model/shibing624_text2vec-base-chinese
       ```
 
-## 5 开发调试
+## 4 开发调试
 
-### 5.1 启动前端项目
+### 4.1 启动前端
 
 !!! Abstract "" 
-      先在ui执行安装前端需要的依赖
 
-      ```bash
-      npm install
-      ```
+    ```bash
+    # 在 `ui`目录 执行安装前端需要的依赖
+    npm install
+    
+    # 然后启动项目
+    npm run dev
+    ```
 
-      启动项目
-      ```bash
-      npm run dev
-      ```
+    启动成功后，如下图显示。
 
-### 5.2 启动后端项目
+![启动前端](../img/dev/npm_run.png){width="500px"}
+
+
+### 4.2 启动后端
 
 !!! Abstract "" 
-      注意: 在项目根目录执行
+    后端系统，需要启动 web服务、本地模型服务、和异步任务队列服务。
+    注意: 在项目根目录执行
 
-      创建venv
-      ```
-      # win
-      python -m venv venv
+!!! Abstract ""
+    在 MaxKB 项目根目录下依次执行以下命令，启动 Web 服务。
 
-      # linux/mac
-      python3 -m venv venv
-      ```
+    ```
+    # 安装 poetry 包管理器
+    pip install poetry
+    
+    # 安装后端需要的依赖
+    poetry install
+    
+    # 启动项目
+    python main.py start
+    ```
 
-      激活 venv
-      ```
-      # win  
-      .\venv\Scripts\activate
+![启动Web服务](../img/dev/main_start.png){width="500px"}
 
-      # linux/mac
-      source venv/bin/activate
-      ```
+!!! Abstract ""
+    在 MaxKB 项目根目录下依次执行以下命令，启动本地模型服务。
 
-      安装后端需要的依赖
+    ```
+    # 启动项目
+    python main.py dev local_model
+    ```
 
-      ```
-      poetry install
-      ```
+![启动本地模型服务](../img/dev/main_localmodel.png){width="500px"}
 
-      启动项目
+!!! Abstract ""
+    在 MaxKB 项目根目录下依次执行以下命令，启动异步任务服务。
 
-      ```
-      python main.py start
-      ```
+    ```
+    # 启动项目
+    python main.py dev celery
+    ```
 
-## 6 常见问题
+![启动异步任务服务](../img/dev/main_celery.png){width="500px"}
 
-!!! Abstract "" 
-      - 关于数据库版本
-      ```
-      postgresql:15.x
-      ```
-      - 关于 Python 版本
-      ```
-      python:3.11.x
-      ```
-      - database "maxkb" does not exist 
+## 5 访问项目
 
-      数据库不存在需要创建一个与配置文件相同的数据库，默认名称为 maxkb。
+!!! Abstract ""
+    前后端都启动成功后，就可以通过前端路由（前端启动出现的访问地址）在浏览器中进行访问。
 
-      ```
-      CREATE DATABASE "maxkb";
-      \c "maxkb";
-      CREATE EXTENSION "vector";
-      ```
+![浏览器访问](../img/dev/maxkb_running.png)