MeetingBot 项目启动与配置教程

1. 项目目录结构及介绍

MeetingBot 是一个开源的视频会议机器人API项目，其目录结构如下：

meetingbot/
├── .github/                      # GitHub 工作流和代码_OF_CONDUCT.md 文件
├── src/                          # 源代码目录
│   ├── backend/                  # 后端代码目录
│   ├── frontend/                 # 前端代码目录
│   └── bots/                     # 机器人代码目录
├── .gitignore                    # Git 忽略文件
├── CODE_OF_CONDUCT.md            # 行为准则
├── CONTRIBUTING.md               # 贡献指南
├── LICENSE                       # 许可证文件
├── README.md                     # 项目说明文件
├── backend.tfvars.example        # 后端 Terraform 变量文件示例
├── infracost.yml                 # Infracost 配置文件
├── package.json                  # 项目包配置文件
├── pnpm-lock.yaml                # pnpm 锁文件
├── pnpm-workspace.yaml           # pnpm 工作空间配置文件
└── terraform.tfvars.example      # Terraform 变量文件示例

• src/: 包含项目的主要源代码。
• .github/: 包含 GitHub 工作流和项目的代码_OF_CONDUCT.md 文件。
• .gitignore: 指定 Git 忽略的文件。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 提供给贡献者的指南。
• LICENSE: 项目的许可证信息。
• README.md: 项目的基本介绍和说明。
• 其他文件: 包括示例配置文件和项目相关配置。

2. 项目的启动文件介绍

项目的启动主要涉及后端和前端的启动。

后端启动

在后端目录 src/backend 下，使用以下命令启动服务：

pnpm dev

启动后，可以通过 http://localhost:{env.PORT}/docs 访问 API 文档。

前端启动

在前端目录 src/frontend 下，使用以下命令启动开发服务器：

pnpm dev

启动后，可以通过 http://localhost:3000 访问前端应用。

3. 项目的配置文件介绍

项目的配置文件主要涉及到 Terraform 的配置，以及环境变量的设置。

Terraform 配置

在项目根目录中，有 backend.tfvars.example 和 terraform.tfvars.example 文件，它们是 Terraform 的变量文件示例。你需要根据实际情况复制这些文件，并进行相应的配置。

例如，backend.tfvars.example 可能需要配置 AWS 的 SSO 信息：

cp backend.tfvars.example backend.tfvars

然后编辑 backend.tfvars 文件，填入正确的配置信息。

环境变量配置

在 src/frontend、src/backend 和 src/bots 目录下，需要将 .env.example 复制为 .env 并进行配置。这些文件包含了应用运行所需的环境变量。

例如：

cp .env.example .env

然后编辑 .env 文件，填入所需的环境变量值。