From cd7266818755996b9062e48ac6742710aca88d8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E6=96=8C?= <259278618@qq.com> Date: Mon, 10 Aug 2026 10:59:25 +0800 Subject: [PATCH] 1 --- CLAUDE.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 83b521c..7d78d96 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,12 +1,8 @@ # CLAUDE.md -## 项目概览 - -rag-local 本地知识库:Go + GoFrame v2 + SQLite(modernc 驱动 + sqlite-vec + FTS5),Vue 3 前端(ui-src,生产构建后由 Go 托管),单端口 :8080。 - ## 目录结构与职责(硬性约束) -> **`biz/` 是泛化占位名,不是固定目录命名**。表格中 `biz/` 代表「业务模块目录」,各项目必须按自身业务命名替换(本项目为 `kb/`),禁止新项目照抄 `biz/`;`ui-src/` 同样为本项目前端目录名,其他项目按自身前端目录替换。 +> **`biz/` 是泛化占位名,不是固定目录命名**。表格中 `biz/` 代表「业务模块目录」,各项目必须按自身业务命名替换(本项目为 `kb/`),禁止新项目照抄 `biz/`;`ui-src/`、`data/`、`workspace/` 亦为本项目目录名,各项目按自身命名。 | 目录 | 职责 | 强约束 | |---|---|---| @@ -16,8 +12,8 @@ rag-local 本地知识库:Go + GoFrame v2 + SQLite(modernc 驱动 + sqlite-vec + | biz/dao/ | 单表数据访问,每表一个文件 | 无业务逻辑;查询经 base_dao 缓存 | | biz/service/ | 业务逻辑:规则校验、文件读写、事务、跨表组装、调用 dao、LLM 编排 | 不直接写 HTTP 响应(例外见下);并行任务走 common 协程池 | | biz/controller/ | 接口层:接收参数、调用 service、组装返回值 | 见「分层职责规范」;禁止调用 dao | -| ui-src/ | Vue 3 + Element Plus 前端 | 开发用 vite 代理,生产构建产物 `ui-src/dist` 由 Go 托管 | -| data/ workspace/ | 运行时数据:SQLite 三个库、上传/解析文件 | 不提交 git;删除即丢失数据,改动前先确认 | +| 前端目录 | Vue 3 + Element Plus 前端(本项目 `ui-src/`) | 开发用 vite 代理,生产构建产物 `dist` 由后端托管 | +| 运行时数据目录 | SQLite 库、上传/解析文件(本项目 `data/` `workspace/`) | 不提交 git;删除即丢失数据,改动前先确认 | ## 分层职责规范(硬性要求) @@ -71,11 +67,10 @@ rag-local 本地知识库:Go + GoFrame v2 + SQLite(modernc 驱动 + sqlite-vec + ## 运维部署规范(硬性要求) -- **部署形态**:Docker Compose 单机部署,前后端一体单端口(默认 8080);`data/` `workspace/` 数据目录挂载持久化,容器重建不丢数据。快速开始见 README,部署文件见项目根目录 `Dockerfile` / `docker-compose.yml` -- **数据即文件**:SQLite 文件型存储,备份 = 打包 `data/`(3 个 db,小而关键)+ `workspace/`(上传源文件,大而可重建)两个目录;迁移 = 拷贝到新机器即可 -- **运行时数据与代码分离**:`data/` `workspace/` 不提交 git;**删除即丢数据,改动前先确认** -- **配置即文件**:`config.yml` 为唯一配置入口(监听端口、上传上限、协程池并发度等),环境变量覆盖无效 -- **访问令牌**:每次启动重新生成并打印在启动日志(`docker compose logs` 查看),重启即换新,旧 JWT 全部失效 +- **部署形态**:Docker Compose 单机部署,前后端一体单端口;运行时数据目录挂载持久化,容器重建不丢数据。部署文件在项目根目录(`Dockerfile` / `docker-compose.yml`),启动与使用见 README +- **数据即文件**:文件型存储,备份 = 打包「数据库目录(小而关键)+ 上传文件目录(大而可重建)」两个目录;迁移 = 拷贝到新机器即可 +- **运行时数据与代码分离**:数据目录不提交 git;**删除即丢数据,改动前先确认** +- **配置即文件**:项目配置文件为唯一配置入口(监听端口、并发度等),环境变量覆盖无效 ## 约定