bitzorcas
中 EN

Guide

快速开始

克隆 BitzOrcas.Modern 并通过一条命令在本地运行整个技术栈。

Last updated

运行模板最快的方式是克隆仓库并通过 .NET Aspire 启动。

1. 克隆仓库

Terminal window
git clone <仓库地址>
cd BitzOrcas.Modern

2. 初始化数据库

API 宿主同时也是 schema 初始化工具。在 Aspire 运行 SQL Server 和 RabbitMQ 的情况下，一次性完成初始化：

Terminal window
# 先启动基础设施（SQL Server + RabbitMQ）
dotnet run --project src/Hosts/BitzOrcas.AppHost &


# 在另一个终端——创建 schema + 种子数据
dotnet run --project src/Hosts/BitzOrcas.Api -- --seed-demo

或者如果你偏好单命令流程，--init-schema 参数效果相同（schema + 审计分表 + 种子数据），然后进程退出不进入 web 管道：

Terminal window
dotnet run --project src/Hosts/BitzOrcas.Api -- --init-schema

可用参数：

参数功能
--init-schema创建所有表 → 审计分表 → 种子数据
--seed-demo与 --init-schema 相同（语义更清晰的别名）
--seed-only跳过建表，仅运行种子数据
--no-seed仅创建表，跳过种子数据

3. 运行 API

数据库就绪后，启动 API（或使用 AppHost 一起启动所有服务）：

Terminal window
# 方式 A：独立 API（需要配置 SQL Server + RabbitMQ 连接串）
dotnet run --project src/Hosts/BitzOrcas.Api


# 方式 B：完整 Aspire 编排（SQL Server + RabbitMQ + API）
dotnet run --project src/Hosts/BitzOrcas.AppHost

启动成功后：

服务地址
API + Scalar 文档https://localhost:7132/scalar
健康检查https://localhost:7132/health
Aspire 仪表板http://localhost:18888（使用 AppHost 时）

4. 验证 Sandbox 模块

模板内置了 Sandbox 模块（Notes、Greetings、Ping）来验证一切正常：

Terminal window
# Ping（健康检查端点）
curl https://localhost:7132/api/v1/ping


# 创建问候
curl -X POST https://localhost:7132/api/v1/greetings \
  -H "Content-Type: application/json" \
  -d '{"name": "World"}'

下一步