LQAdminPlatform/项目/项目结构.md

项目结构 LQAdminPlatform

• 功能模块

  • 系统管理
    • 用户管理
    • 角色管理
    • 菜单管理
    • 权限管理
    • 系统日志
    • 仪表盘
    • 应用管理
  • 授权管理
    • 授权认证
    • SSO验证凭证，生成授权码
    • 重定向回子系统并携带授权码
    • 子系统用授权码换取Access Token
    • 子系统用Token获取用户信息
    • 用户登录成功
    • 子系统登录认证
    • JWT token 令牌管理（验证、刷新等）
  • 样本中心
    • 知识库管理
    • 文档管理
    • 知识片段管理
    • 标签管理
    • 检索引擎
    • 文档基本信息
    • 图片管理
      

• 项目结构

  • requirements/requirements.txt 项目所需要插件依赖项
  • Dockerfile docker 容器打包Dockerfile配置
  • src/app/server
    
  • app.py 项目启动类
  • src/app/logger 日志配置类
  • loggering.py
  • 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/system 系统管理
  • schemas 每个模块自己的结构
  • models 每个模型自己的模型
  • src/app/oauth 授权管理
  • schemas 每个模块自己的结构
  • models 每个模型自己的模型
  • 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 单元测试类定义

• 本次修改：

  • 将现有功能按功能模块划分到对应的项目结构下 ，如：
    • src/app/system 系统管理
    • src/app/oauth 授权管理
    • src/app/sample 样本中心
  • 把full_server.py 中的应用服务相关的代码迁移到 src/app/server/app.py

项目前端开发结构 LQAdminFront

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

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

  • system 系统管理
    • admin.ts 管理员
    • app.ts 应用管理
    • user.ts 用户管理
    • role.ts 角色管理
    • menu.ts 菜单管理
  • oauth 授权管理
  • sample 样本中心
    • document.ts
  • auth 用户登录认证
    • auth.ts 用户登录

• src/views 按模糊划分view

  • auth 用户登录
    • Login.vue
    • OAuthCallback.vue
    • Register.vue

  • system

    • Apps.vue 应用管理
    • Dashboard.vue 仪表盘
    • Menus.vue 菜单管理
    • Permissions.vue 权限管理
    • Roles.vue 角色管理
    • Settings.vue 系统设置
    • Users.vue 用户管理
      

  • sample 样本中心

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