MeetingBot 开源项目教程

1. 项目介绍

MeetingBot 是一个开源的会议机器人 API，它提供了将机器人发送到视频会议（如 Google Meet、Microsoft Teams 和 Zoom）并记录会议的基础设施。开发者可以利用这个基础设施，仅用几行代码就能构建使用会议录制数据的应用程序。所有的基础设施都是使用 Terraform 定义的，并部署到 AWS 上，这使得用户可以轻松地自行托管 MeetingBot，以保持数据隐私并降低成本。

2. 项目快速启动

环境准备

在开始之前，确保你已经安装了以下依赖：

• AWS 账户
• Terraform
• Node.js (版本 >=18.0.0)
• pnpm (版本 >=8.0.0)
• Docker (用于构建机器人镜像)
• AWS CLI
• Route 53 中的一个域名
• 用于存储 Terraform 状态的 S3 桶
• (可选) 用于锁定 Terraform 状态的 DynamoDB 表
• GitHub App 用于仪表板认证

克隆仓库

git clone https://github.com/meetingbot/meetingbot.git
cd meetingbot

设置 AWS 凭证

# 可以通过登录 AWS 或者运行以下 make 命令来配置
make sso

这会配置名为 'meetingbot' 的 AWS SSO 配置。

初始化 Terraform

cp backend.tfvars.example backend.tfvars
cp terraform.tfvars.example terraform.tfvars
# 修改 .tfvars 文件中的配置值
make init

选择 Terraform 工作区

terraform workspace select dev
# 或者创建一个新的工作区：terraform workspace new dev

部署基础设施

terraform apply

配置环境变量

将 .env.example 复制到 src/frontend、src/backend 和 src/bots 目录中的 .env。具体信息请参考每个目录中的 README。

在每个目录中安装依赖：

cd src/frontend && pnpm install
cd src/backend && pnpm install
cd src/bots && pnpm install

3. 应用案例和最佳实践

• 部署 Terraform 基础设施：按照 Terraform README 中的说明部署必要的 AWS 资源。
• 运行后端：导航到 src/backend 目录，使用 pnpm dev 启动服务器。可以通过 http://localhost:{env.PORT}/docs 访问 API 文档。
• 运行前端：导航到 src/frontend 目录，使用 pnpm dev 启动开发服务器。可以通过 http://localhost:3000 访问应用。
• 创建 API 密钥：使用前端界面创建 API 密钥，以便你的应用能够与 MeetingBot API 认证。
• 部署机器人：使用 API 端点将机器人部署到你的目标会议平台。
• 访问录制：使用 API 端点检索会议录制和元数据。

4. 典型生态项目

MeetingBot 的生态系统包括以下几个部分：

• 前端框架：Next.js
• 后端框架：Express
• API 层：tRPC
• ORM：Drizzle ORM
• 数据库：PostgreSQL
• 基础设施即代码：Terraform
• 云服务提供商：AWS
• 容器化：Docker
• 包管理器：pnpm
• 持续集成/持续部署：GitHub Actions

以上是 MeetingBot 开源项目的最佳实践和快速启动指南。希望这能帮助你顺利地开始使用这个强大的工具。