1. 一级文件夹
1.1. backend/
这是项目的后端代码,使用 Golang 开发。包含:
- api/ :API 接口定义和处理
- application/ :应用层逻辑
- conf/ :配置文件
- domain/ :领域模型和业务逻辑(遵循 DDD 设计原则)
- infra/ :基础设施层
- pkg/ :通用工具包
- types/ :类型定义
1.2. frontend/
前端代码,使用 React + TypeScript 开发。包含:
- apps/ :应用程序
- packages/ :组件包
- config/ :配置文件
- infra/ :基础设施层
- scripts/ :脚本工具
1.3. idl/
接口定义语言文件,用于服务间通信。包含各种服务的 Thrift 定义文件,如:
- conversation/ :对话相关接口
- plugin/ :插件相关接口
- flow/ :工作流相关接口
- memory/ :记忆相关接口
1.4. docker/
容器化配置,包含:
- docker-compose.yml :Docker Compose 配置文件
- .env.example :环境变量示例
- volumes/ :数据卷配置
- atlas/ :数据库迁移工具
1.5. common/
公共组件和配置:
_templates/
:模板文件- config/ :公共配置
- git-hooks/ :Git 钩子脚本
- scripts/ :公共脚本
1.6. scripts/
项目脚本工具:
- build_fe.sh :前端构建脚本
- setup/ :环境设置脚本
- start_fe.sh :前端启动脚本
- volcengine/ :火山引擎相关脚本
1.7. .github/
GitHub 配置和工作流:
- workflows/ :GitHub Actions 工作流配置
- ISSUE_TEMPLATE/ :Issue 模板
- CODEOWNERS :代码所有者配置
1.8. helm/
Kubernetes Helm 配置,用于 Kubernetes 部署:
- charts/ :Helm Chart 配置
1.9. docs/
项目文档目录
2. 一级文件
2.1. README.md 和 README.zh_CN.md
项目的英文和中文说明文档,介绍了 Coze Studio 是什么、功能列表、快速开始指南、开发者指南等。
2.2. LICENSE-APACHE
项目使用的 Apache 2.0 许可证。
2.3. CONTRIBUTING.md
贡献指南,说明如何为项目做贡献。
2.4. CODE_OF_CONDUCT.md
行为准则,规定了参与项目的行为规范。
2.5. Makefile
项目构建和管理的 Makefile。
2.6. rush.json
Rush 是一个用于管理 JavaScript 单仓库的工具,这是其配置文件。
2.7. .gitignore
Git 忽略文件配置。
2.8. .nvmrc
Node 版本管理器配置文件,指定项目使用的 Node.js 版本。
2.9. .prettierrc.js
Prettier 代码格式化工具的配置文件。
本文由 huzd 创作,采用 知识共享署名4.0 国际许可协议进行许可本站文章除注明转载/出处外,均为本站原创或翻译,转载前请务必署名最后编辑时间
为:
2025/07/31 10:45