应用结构
Genstore CLI 创建的应用遵循统一的目录结构规范,帮助您实现标准化开发和高效管理。每个目录和文件都具有明确的职责,确保应用结构清晰可维护。
目录结构概览
bash
your-app/
├── genstore.app.toml # 必需:应用主配置文件
├── genstore.app.{config-name}.toml # 可选:多环境配置文件
├── package.json # 必需:项目依赖配置
├── app/ # 必需:应用代码目录
│ └── ... # 入口点、路由和 Webhook
└── extensions/ # 可选:扩展目录
└── your-extension/ # 扩展示例
├── genstore.extension.toml # 扩展配置文件
└── ...
核心文件说明
配置文件
名称 | 必需 | 描述 |
---|---|---|
genstore.app.toml | 是 | 包含应用的元数据和配置的文件,代表应用的根目录 |
genstore.app.{config-name}.toml | 否 | 包含一个或多个项目的配置文件,用于在本地管理应用配置并与 Genstore 同步 |
package.json | 是 | 包含 Node 相关的项目元数据 包含项目依赖项和脚本 用于使用包管理器运行 Genstore CLI 命令 目子文件夹可能包含额外的 package.json |
目录结构
名称 | 必需 | 描述 |
---|---|---|
app/ | 是 | 包含应用的入口点、路由和 Webhook 目录 |
extensions/ | 否 | 包含应用中生成的扩展 每个子目录代表一个扩展 扩展目录名即为扩展的本地标识符 每个扩展目录必须包含一个 TOML 配置文件 |
配置文件详细说明
主配置文件(genstore.app.toml
)
主配置文件是应用级配置和元数据的核心配置文件。当您首次运行 app dev
命令时,Genstore CLI 会自动:
- 将当前项目与 Genstore 应用建立关联
- 在配置文件中更新相关配置信息
- 生成必要的应用标识和凭证
环境配置文件(genstore.app.{config-name}.toml
)
通过 genstore.app.{config-name}.toml
,您可:
- 将项目链接到多个 Genstore 应用
- 管理不同环境(开发、测试、生产)的配置
- 独立维护各环境的专属设置