Bläddra i källkod

update README.md.

Signed-off-by: 季圣华 <752718920@qq.com>
季圣华 2 månader sedan
förälder
incheckning
7fb283552b
1 ändrade filer med 60 tillägg och 5 borttagningar
  1. 60 5
      README.md

+ 60 - 5
README.md

@@ -38,12 +38,61 @@ QQ技术交流群:818914680 欢迎加入,一起学习!商务或技术交
 |          Netty管理          | 客户端、Mqtt统计 | 
 |          权限管理          | 基于若依的权限管理系统,用户、角色、菜单、部门、岗位、权限、日志等  | 
 
-#### 参与贡献
 
-1.  Fork 本仓库
-2.  新建 Feat_xxx 分支
-3.  提交代码
-4.  新建 Pull Request
+#### 源码目录
+```
+gyj-iot-web/                          # 管伊佳物联网平台前端项目
+├── html/                             # 静态HTML页面(IE兼容性提示等)
+├── public/                           # 公共资源目录(不参与构建处理)
+│   ├── js/                           # 第三方JS库(播放器、MQTT客户端等)
+│   ├── screen/                       # 数据大屏展示图片资源
+│   ├── styles/                       # 公共样式文件
+│   └── favicon.ico                   # 网站图标
+├── src/                              # 源代码目录(核心开发目录)
+│   ├── api/                          # API接口定义(IoT、系统、监控等模块)
+│   ├── assets/                       # 静态资源(图片、图标、样式)
+│   ├── components/                   # 公共组件(表格、表单、上传等)
+│   ├── directive/                    # 自定义指令(权限、通用指令)
+│   ├── layout/                       # 布局组件(侧边栏、导航栏等)
+│   ├── plugins/                      # 插件封装(权限、缓存、下载等)
+│   ├── router/                       # 路由配置
+│   ├── store/                        # 状态管理(Pinia)
+│   ├── utils/                        # 工具函数(请求、验证、MQTT等)
+│   └── views/                        # 页面视图(业务页面)
+├── vite/                             # Vite构建插件配置
+├── .env.development                  # 开发环境变量配置
+├── .env.production                   # 生产环境变量配置
+├── .env.staging                      # 测试环境变量配置
+├── index.html                        # 入口HTML文件
+├── package.json                      # 项目依赖与脚本配置
+└── vite.config.js                    # Vite构建配置文件
+
+gyj-iot-boot/
+├── gyjiot-admin/              # 管理后台模块 - Web应用入口,提供系统管理界面和API接口
+├── gyjiot-common/             # 通用工具模块 - 公共常量、工具类、异常处理、注解等基础组件
+├── gyjiot-framework/          # 框架核心模块 - Spring Security、AOP切面、数据源配置等框架级功能
+├── gyjiot-open-api/           # 开放API模块 - 对外提供的数据接口控制器和定时任务
+├── gyjiot-gateway/            # 网关模块
+│   ├── gateway-boot/          # 网关启动模块 - API网关服务入口
+│   └── gyjiot-mq/             # 消息队列模块 - MQTT消息处理相关功能
+├── gyjiot-plugs/              # 插件模块集合
+│   ├── gyjiot-generator/      # 代码生成器 - 自动生成CRUD代码的工具
+│   ├── gyjiot-http/           # HTTP客户端 - HTTP请求封装和处理
+│   ├── gyjiot-mqtt-client/    # MQTT客户端 - MQTT协议客户端实现
+│   ├── gyjiot-quartz/         # 定时任务 - Quartz调度器集成
+│   └── gyjiot-ruleEngine/     # 规则引擎 - IoT设备数据处理规则引擎
+├── gyjiot-protocol/           # 协议解析模块
+│   └── gyjiot-protocol-collect/ # 协议采集 - 多协议数据采集和解析
+├── gyjiot-server/             # IoT服务器模块
+│   ├── base-server/           # 基础服务 - IoT设备管理基础功能
+│   ├── boot-strap/            # 启动引导 - MQTT服务启动引导
+│   ├── iot-server-core/       # 核心服务 - IoT服务器核心逻辑
+│   ├── mqtt-broker/           # MQTT代理 - MQTT消息代理服务
+│   └── sip-server/            # SIP服务 - 视频流SIP协议支持
+└── gyjiot-service/            # 业务服务模块
+    ├── gyjiot-iot-service/    # IoT业务服务 - 设备管理、数据采集等业务逻辑
+    └── gyjiot-system-service/ # 系统管理服务 - 用户、角色、权限等系统管理
+```
 
 #### 系统截图
 * 首页
@@ -63,3 +112,9 @@ QQ技术交流群:818914680 欢迎加入,一起学习!商务或技术交
 * 权限管理
 ![输入图片说明](gyj-iot-web/public/screen/8.png)
 
+#### 参与贡献
+
+1.  Fork 本仓库
+2.  新建 Feat_xxx 分支
+3.  提交代码
+4.  新建 Pull Request