开源项目教程：Meeting Minutes

开源项目教程：Meeting Minutes

meeting-minutes An open source Live Ai based meeting minutes generator that can completely run in your PC. 项目地址: https://gitcode.com/gh_mirrors/me/meeting-minutes

1. 项目目录结构及介绍

Meeting Minutes 项目是一个开源的 AI 会议记录助手，它能够实时捕捉会议音频、转录并生成总结。以下是项目的目录结构及其介绍：

meeting-minutes/
├── backend/                # 后端代码目录
│   ├── .env                # 环境变量配置文件
│   ├── build_whisper.sh    # 构建 Whisper 脚本（Linux/macOS）
│   ├── build_whisper.bat   # 构建 Whisper 脚本（Windows）
│   ├── clean_start_backend.sh # 清除并启动后端脚本（Linux/macOS）
│   ├── requirements.txt    # 后端依赖文件
│   ├── start_with_output.ps1 # 启动后端脚本（Windows）
│   └── whisper/            # Whisper 转录引擎相关文件
├── frontend/               # 前端代码目录
├── .gitignore              # Git 忽略文件
├── .gitmodules             # Git 子模块配置文件
├── LICENSE.md              # 项目许可证文件
├── README.md               # 项目说明文件

• backend/: 包含后端的代码和配置文件。
• frontend/: 包含前端代码，通常是用于用户交互的界面。
• .env: 环境变量配置文件，用于存储 API 密钥和敏感信息。
• .gitignore: 指定 Git 应该忽略的文件和目录。
• .gitmodules: 如果项目包含子模块，这个文件会列出它们。
• LICENSE.md: 项目的许可证信息，通常是 MIT 许可。
• README.md: 项目的基本信息和说明。

2. 项目的启动文件介绍

启动文件用于初始化和运行项目。以下是主要启动文件的介绍：

• build_whisper.sh 和 build_whisper.bat: 这两个脚本用于构建 Whisper 转录引擎，分别适用于 Linux/macOS 和 Windows 系统。
• clean_start_backend.sh: 这个脚本用于清除后端服务的任何遗留进程，并启动后端服务，适用于 Linux/macOS 系统。
• start_with_output.ps1: 这个 PowerShell 脚本用于启动后端服务，并显示输出，适用于 Windows 系统。

3. 项目的配置文件介绍

配置文件用于定制项目的运行环境。以下是主要的配置文件：

• .env: 环境变量配置文件，用于存储项目的配置信息，如 API 密钥等敏感数据。文件内容示例如下：

ANTHROPIC_API_KEY=your_api_key
GROQ_API_KEY=your_groq_api_key

确保在运行项目之前，正确填写这些信息，以避免不必要的错误。

以上就是 Meeting Minutes 项目的目录结构、启动文件和配置文件的介绍。在使用之前，请确保您的开发环境中安装了所有必要的依赖项，并正确配置了环境变量。

meeting-minutes An open source Live Ai based meeting minutes generator that can completely run in your PC. 项目地址: https://gitcode.com/gh_mirrors/me/meeting-minutes