docs: 更新多仓拆分与运维指引

This commit is contained in:
root
2026-01-29 05:57:48 +00:00
parent 318aded4bf
commit 79fcefaebc
4 changed files with 154 additions and 13 deletions

View File

@@ -51,15 +51,31 @@
## 快速开始
### 1. 克隆项目
### 1. 克隆仓库(已拆分为多仓 + 子模块)
> 推荐使用 `--recurse-submodules` 一次性拉取共享库与文档子模块。
**管理后台 AdminApi**
```bash
git clone https://github.com/your-org/takeout-saas.git
cd takeout-saas
git clone --recurse-submodules -b dev git@github.com:msumshk/TakeoutSaaS.AdminApi.git
cd TakeoutSaaS.AdminApi
```
**租户端 TenantApiMiniApi/UserApi**
```bash
git clone --recurse-submodules -b dev git@github.com:msumshk/TakeoutSaaS.TenantApi.git
cd TakeoutSaaS.TenantApi
```
**若未使用 `--recurse-submodules`**
```bash
git submodule update --init --recursive
```
### 2. 使用Docker Compose启动依赖服务推荐
```bash
# 启动PostgreSQL、Redis、RabbitMQ等服务
# 在你的 docker-compose.yml 所在目录执行(示例)
# 启动 PostgreSQL、Redis、RabbitMQ 等服务
docker-compose up -d
# 查看服务状态
@@ -67,22 +83,30 @@ docker-compose ps
```
### 3. 配置数据库连接
编辑 `src/TakeoutSaaS.Api/appsettings.Development.json`
编辑各服务的配置文件:
- AdminApi`src/Api/TakeoutSaaS.AdminApi/appsettings.Development.json`
- MiniApi`src/Api/TakeoutSaaS.MiniApi/appsettings.Development.json`
- UserApi`src/Api/TakeoutSaaS.UserApi/appsettings.Development.json`
### 4. 执行数据库迁移
```bash
cd src/TakeoutSaaS.Api
dotnet ef database update
```
### 4. 执行数据库迁移(如需)
迁移执行与设计期 DbContext 配置请参考:`Document/10_设计期DbContext配置指引.md`
### 5. 运行项目
```bash
dotnet run
# AdminApi
dotnet run --project src/Api/TakeoutSaaS.AdminApi/TakeoutSaaS.AdminApi.csproj
# MiniApiTenantApi 仓库内)
dotnet run --project src/Api/TakeoutSaaS.MiniApi/TakeoutSaaS.MiniApi.csproj
# UserApiTenantApi 仓库内)
dotnet run --project src/Api/TakeoutSaaS.UserApi/TakeoutSaaS.UserApi.csproj
```
访问 API 文档:
- 管理后台 AdminApi Swaggerhttp://localhost:5001/api/docs
- 小程序/用户端 MiniApi Swaggerhttp://localhost:5002/api/docs
- Swagger UI`/api/docs`(旧入口 `/swagger` 仍保留)
- 端口以各项目 `Properties/launchSettings.json` 或部署配置为准
## 字典管理