综合介绍
GitPodcast 是一个创新的工具,旨在将 GitHub 仓库转化为播客,让开发者可以随时随地收听代码更新。通过使用 OpenAI 和 Azure Speech SDK,GitPodcast 能够将 GitHub 仓库中的提交记录、拉取请求和里程碑等内容生成音频摘要,让开发者在不方便阅读代码时也能获取项目更新。无论是在通勤、锻炼还是休息时,GitPodcast 都能帮助开发者随时随地了解代码变更。
功能列表
- GitHub仓库转播客:将 GitHub 仓库中的提交记录、拉取请求和里程碑生成音频摘要。
- AI音频生成:利用 AI 技术自动生成音频内容,提供高效的代码更新方式。
- 多任务处理:支持开发者在进行其他任务时,通过音频了解项目进展。
- 自定义选项:选择不同的声音(开发中)
- API 访问:提供公共 API 供集成使用(开发中)
- 无缝集成:简单连接 GitHub 账户,即可开始使用。
- 完全免费:无需任何费用或订阅,提供免费服务。
使用帮助
安装与设置
- 克隆仓库:
git clone https://github.com/BandarLabs/gitpodcast.git cd gitpodcast
- 安装依赖:
pnpm i
- 设置环境变量:
cp .env.example .env
编辑
.env
文件,添加你的 Anthropic API 密钥和可选的 GitHub 个人访问令牌。
运行后端
- 启动 Docker 容器:
docker-compose up --build -d
日志可通过以下命令查看:
docker-compose logs -f
FastAPI 服务器将运行在
localhost:8000
。 - 启动本地数据库:
chmod +x start-database.sh ./start-database.sh
当提示生成随机密码时,输入
yes
。Postgres 数据库将运行在localhost:5432
。 - 初始化数据库架构:
pnpm db:push
你可以使用以下命令查看和交互数据库:
pnpm db:studio
运行前端
- 启动前端开发服务器:
pnpm dev
你现在可以在
localhost:3000
访问网站,并在backend/app/routers/generate.py
文件中编辑生成函数装饰器中定义的速率限制。
如何开始使用 GitPodcast
- 连接 GitHub 账户:
- 访问 GitPodcast 网站(https://www.gitpodcast.com/)。
- 点击“连接 GitHub 账户”按钮,按照提示进行授权。
- 授权完成后,GitPodcast 将自动获取你的 GitHub 仓库信息。
- 生成音频摘要:
- 在 GitPodcast 网站上选择你希望生成音频摘要的 GitHub 仓库。
- 点击“生成播客”按钮,AI 将自动生成该仓库的音频摘要。
- 生成的音频摘要将显示在你的播客列表中。
- 收听音频摘要:
- 在播客列表中选择你希望收听的音频摘要。
- 点击播放按钮,即可开始收听代码更新。
- 你可以在通勤、锻炼或休息时,通过耳机随时随地收听。
详细功能操作流程
- 连接 GitHub 账户:
- 打开 GitPodcast 网站,点击首页的“连接 GitHub 账户”按钮。
- 系统将跳转到 GitHub 授权页面,输入你的 GitHub 账户信息并授权。
- 授权成功后,系统将返回 GitPodcast 网站,并显示你的 GitHub 仓库列表。
- 选择仓库并生成音频摘要:
- 在 GitPodcast 网站上,浏览你的 GitHub 仓库列表。
- 选择你希望生成音频摘要的仓库,点击“生成播客”按钮。
- 系统将自动分析该仓库的提交记录、拉取请求和里程碑,并生成音频摘要。
- 收听音频摘要:
- 在播客列表中,找到你希望收听的音频摘要。
- 点击播放按钮,即可开始收听。
- 你可以通过耳机或音响设备,随时随地收听代码更新。
- 管理播客:
- 你可以在 GitPodcast 网站上管理你的播客列表。
- 删除不需要的音频摘要,或重新生成新的音频摘要。
- 通过简单的操作,保持你的播客列表整洁有序。
GitPodcast 提供了一个高效、便捷的方式,让开发者在忙碌的日常生活中,依然能够保持对项目的关注。通过 AI 技术生成的音频摘要,开发者可以在任何时间、任何地点,轻松了解代码更新,提升工作效率。