LQAdminPlatform/项目/项目追加开发说明.md

项目追加开发结构 LQAdminPlatform

• 功能模块

  • system 系统管理
    • user 用户管理
      
    • role 角色管理
      
    • menu 菜单管理
      
    • permission 权限管理
      
    • log 系统日志
      
    • dashboard 仪表盘
    • app 应用管理

  • sample 样本中心

    • knowledge_base 知识库管理
    • doucments 文档管理
    • knowledge_chunk 知识片段管理
    • tag 标签管理
    • knowledge_chunk_search 知识片段检索引擎
    • base_info 基本信息
    • image 图片管理
    • 基本信息
    • 施工标准规范知识库 standard_base_info
    • 施工方案知识库 construction_plan_base_info
    • 办公制度知识库 office_regulations
    • 施工标准规范专业术语实体 technical_term_entity
      

  • 模块名称简写

  • 系统管理 sys

  • 授权管理 auth

  • 样本中心 samp

• 项目结构

  • src/app/core
  • execeptions.py 通用异常类定义
  • src/app/models 通用模型定义
  • base.py 通用模型类定义
  • src/app/utils 各类工具类
  • src/app/config 各类配置，如：yaml 配置等
  • *.yaml
  • src/app/base 基础信息，如：MySQL数据库、Redis缓存连接、milvus向量数据库
  • async_redis_connection.py
  • async_mysql_connection.py
  • milvus_conneciton.py
  • src/app/schemas 基础的结构
  • base.py
    
  • src/app/sample 样本中心
  • schemas 每个模块自己的结构
  • models 每个模型自己的模型
  • src/app/api 对外部提供API定义
  • src/app/services 业务逻辑层定义
    • auth_service.py 用户登录认证
    • system_service.py 系统管理
    • sample_service.py 样本中心管理
  • src/views 不同模块的API路由
  • system_view.py
  • oauth_view.py
  • sample_view.py
  • src/test 单元测试类定义

• 数据库表名称定义

  • 表名称要求：以 "t_模块名称简写_表名称" 如：t_sys_user

  • 每个业务表增加创建人 、创建时间、修改人、修改时间 created_by varchar(36) DEFAULT NULL COMMENT '创建人', created_time datetime DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间，默认当前时间', updated_by varchar(36) DEFAULT NULL COMMENT '修改人', updated_time datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间，默认当前时间',

  • 创建的数据库表名称和字段都需要增加 common 注释说明，如下： COMMENT='施工标准规范'; chinese_name varchar(255) NOT NULL COMMENT '中文名称',

3、

项目前端开发结构 LQAdminFront

• src/router 路由
• src/components 组件
• src/layouts 布局
• src/utils 工具

• src/api 按模块划分API请求

  • sample 样本中心
    • document.ts 登录

• src/views 按模糊划分view

  • sample 样本中心
    • knowledge_base 知识库管理
    • doucments 文档管理
    • knowledge_chunk 知识片段管理
    • tag 标签管理
    • knowledge_chunk_search 知识片段检索引擎
    • base_info 基本信息
    • image 图片管理