mirror of
https://gitee.com/ulthon/ulthon_admin.git
synced 2026-07-01 15:32:48 +08:00
docs: 更新 source 目录结构说明与相关文档
- 在 source 下新增 docs、projects、attachments 目录并添加 .gitkeep 占位文件 - 更新 source/README.md,明确 source 目录用于存放主工程外的配套内容,并详细说明新增子目录用途 - 同步更新 AGENTS.md 中的相关描述,保持文档一致性
This commit is contained in:
@@ -1,29 +1,33 @@
|
||||
# source/
|
||||
|
||||
本目录用于收纳“配套资源与多端代码”,不影响现有 PHP/ThinkPHP 主工程运行与发布。根目录仍是后端工程的唯一入口。
|
||||
本目录用于收纳“主工程之外的配套内容”,包括多端代码、各类子项目、资料与附件等,不影响当前主工程运行与发布。根目录仍是主工程入口。
|
||||
|
||||
## 目录约定
|
||||
|
||||
- `source/assets/`:通用静态资源(模板、字体、设计稿导出等)
|
||||
- `source/assets/templates/`
|
||||
- `source/assets/fonts/`
|
||||
- `source/docs/`:项目资料(说明文档、流程文档、交付文档等)
|
||||
- `source/attachments/`:附件与素材(非代码交付物、原始文件等)
|
||||
- `source/docker/`:附属服务/可选服务编排与开发辅助(与根目录 `docker/` 区分)
|
||||
- `source/clients/`:各端前端/客户端工程
|
||||
- `source/clients/uniapp/`:uni-app(Vue3 + Vite + JavaScript)
|
||||
- `source/clients/vue-screen/`:预留“大屏端”目录
|
||||
- `source/projects/`:各类子项目(可为 PHP 或其他技术栈,如 Python/Go/Node 工具或服务)
|
||||
- `source/stack/`:部署栈模式文件(`default/` 与各模式目录)
|
||||
|
||||
## 命名规则
|
||||
|
||||
- 统一小写,使用 `-` 连接(如 `vue-screen`)
|
||||
- 目录按 `clients / assets / docker` 分类
|
||||
- 目录按 `clients / projects / assets / docs / attachments / docker / stack` 分类
|
||||
|
||||
## 依赖与构建产物
|
||||
|
||||
- 每个子工程自带依赖清单(例如 `package.json`)
|
||||
- 禁止提交依赖目录与构建产物(例如 `node_modules/`、`dist/`)
|
||||
- 资料与附件目录建议保留原始格式,避免混入可执行产物或临时缓存
|
||||
|
||||
## 安全约束
|
||||
|
||||
- 禁止在该目录提交任何密钥/证书/私有 token
|
||||
- 如需环境变量,提交 `.env.example`,不要提交真实 `.env`
|
||||
-
|
||||
|
||||
Reference in New Issue
Block a user