docs: document Sense product skeleton (#21)

This commit is contained in:
QiuSW
2026-08-12 16:51:44 +08:00
parent d2169990d3
commit 2e22252feb
3 changed files with 48 additions and 6 deletions
+16 -2
View File
@@ -2,8 +2,8 @@
generated: true (请先修改 Gitea Wiki,禁止直接编辑本文件)
wiki_page: Architecture-and-Code-Map
wiki_url: https://git.ilapage.cn/ila/yovision/wiki/Architecture-and-Code-Map.-
wiki_revision: 04b5eaea579729e427f1b2b8962399e861d5eb53
synchronized_at: 2026-08-11T10:30:34Z
wiki_revision: f16f2956d3d0f260501a356b5fe1087abdc5eaf5
synchronized_at: 2026-08-12T08:50:52Z
<!-- gitea-wiki-mirror:end -->
# 架构与代码地图
@@ -79,3 +79,17 @@ Sense/Brain 生成事件
- 业务预警与运维告警分开。
- Area/设备/规则在各独立产品内有自己的业务投影,不以共享数据库同步。
- 单项目工单不得顺带修改其他项目;共享契约变更必须由协调工单统筹。
<!-- sense-runtime:start -->
## Sense 代码入口与模块边界
- `Sense/server/main.go`:后端进程入口,调用 `cmd/sense` 启动。
- `Sense/server/cmd/sense/root.go`:配置、数据库、迁移、模块注册和优雅退出编排;后续功能通过独立 `modules_<feature>.go` 注册,不反复修改共享入口。
- `Sense/server/internal/platform/`:PostgreSQL、迁移、HTTP/JSON、健康检查与静态资源宿主。
- `Sense/ui/src/bootstrap/`:Vue、路由、Vuex、请求封装和功能模块自动发现。
- `Sense/ui/src/layout/AppLayout.vue`:基于 go-admin-ui 交互约定的侧栏、顶部导航、标签栏和页面容器。
- `Sense/config/`:无秘密配置模板;真实数据库 URL 和后续签名密钥只能由仓库外环境提供。
- `Sense/scripts/bootstrap/`:精确工具链检查和无需 Brain/Bell 的内存模式 smoke。
默认只注册工作台、健康检查和系统信息;go-admin 演示与代码生成菜单、路由和后端接口均未注册。正式启动默认要求独立 PostgreSQL;`memory` 只用于自动化测试和本地 smoke。
<!-- sense-runtime:end -->