项目结构
目录总览
readystart/
├── api/ # 后端业务开发区域
│ ├── src/
│ │ ├── main.ts # 入口
│ │ ├── app.module.ts # 根模块(注册你的 Controller)
│ │ ├── controllers/ # 你的业务 Controller
│ │ ├── services/ # 你的业务 Service
│ │ ├── config/website/ # 配置文件(支付、租户)
│ │ ├── config/mail/ # 邮件模板
│ │ ├── migrations/ # 你的数据库迁移
│ │ └── utils/ # 工具函数
│ └── views/ # 页面模板(hbs)
│
├── console/ # 前端业务开发区域
│ ├── src/
│ │ ├── router/ # 路由 + 守卫
│ │ ├── pages/ # 你的页面
│ │ ├── layouts/ # 布局组件
│ │ ├── config/ # 菜单、支付配置
│ │ └── styles/ # 样式
│
├── libs/api-core/ # 核心后端(不建议修改)
│ └── src/
│ ├── auth/ # 认证
│ ├── billing/ # 计费
│ ├── tenant/ # 多租户
│ ├── users/ # 用户
│ ├── admin/ # 管理后台
│ ├── notification/ # 通知
│ ├── system/ # 系统
│ └── shared/ # 共享(Guard、Service、Interface)
│
├── libs/console-core/ # 核心前端(不建议修改)
│ └── src/
│ ├── api/ # API 调用层
│ ├── stores/ # Zustand 状态管理
│ ├── features/ # 功能页面组件
│ ├── components/ # UI 组件
│ └── utils/ # 工具函数
│
├── website/ # 官网(Astro)
└── docker/ # Docker 配置
核心库 vs 业务代码
| 核心库(libs/) | 业务代码(api/、console/) |
|---|
| 作用 | 提供基础功能 | 你的业务逻辑 |
| 是否修改 | 不建议 | 自由修改 |
| 包名 | @readystart/api-core、@readystart/console-core | — |
配置文件
配置文件在 api/src/config/website/ 下,通过 CONFIG_SUFFIX 环境变量加载:
CONFIG_SUFFIX=local → payment.local.ts + tenant.local.ts
CONFIG_SUFFIX=example → payment.example.ts + tenant.example.ts
| 文件 | 说明 |
|---|
payment.{suffix}.ts | 支付配置(订阅方案、积分包、价格) |
tenant.{suffix}.ts | 租户配置(自定义角色) |