Skip to content

Leejaywell/github-i18n

Repository files navigation

GitHub 仓库 AI 文档翻译平台

项目介绍

基于 Next.js + GitHub App + OpenRouter,用 AI 编程的方式从 0 到 1 开发一个《GitHub 仓库 AI 文档翻译 SaaS 平台》, 输入任意一个 GitHub 仓库地址,AI 自动将文档翻译成多种语言,并在基准语言内容发生变更时,自动增量同步翻译,生成 PR 等待仓库负责人合并,全程无需人工干预。

为什么做这个项目?

为了让海外用户也能看到,希望把仓库翻译成多语言版本,但人工翻译成本太高,GitHub Actions 又要自己折腾配置……

既然如此,不如做一个更通用的工具

这就是 GitHub I18N 项目的起点:输入任意一个 GitHub 仓库地址,AI 自动将文档翻译成多种语言,并在基准语言内容发生变更时,自动增量同步翻译,生成 PR 等待仓库负责人合并,全程无需人工干预。

零配置,一键翻译,让你的 GitHub 项目走向全球!

6 大核心能力

1)用 GitHub 账号一键登录,基于 GitHub App 实现安全登录与授权。 2)导入 GitHub 仓库,输入地址即可自动拉取仓库信息。 3)配置翻译,可视化选择翻译范围和目标语言(支持 20 种主流语言)。 4)一键执行翻译,实时展示进度,翻译完成后自动创建 PR。 仓库负责人可以自己选择是否合并本次翻译,既方便又安全: 5)自动触发增量翻译,开启后每次 Push 都会自动翻译变更的文档。 6)自定义大模型和 API Key,支持 GPT、Claude、Gemini、DeepSeek 等主流模型。

快速运行

详细的保姆级教程请参考 本地运行指南

前置条件

1. 克隆并安装依赖

git clone https://github.com/Leejaywell/github-i18n.git
cd github-i18n
npm install

2. 配置环境变量

# 创建环境变量文件(两个文件内容保持一致)
cp .env.example .env
cp .env.example .env.local

编辑 .env.env.local,填入你的配置:

DATABASE_URL=mysql://root:你的密码@localhost:3306/github_i18n
NEXTAUTH_URL=http://localhost:3123
AUTH_SECRET=随机字符串至少32位
GITHUB_APP_ID=你的AppID
GITHUB_APP_CLIENT_ID=你的ClientID
GITHUB_APP_CLIENT_SECRET=你的ClientSecret
GITHUB_APP_PRIVATE_KEY_PATH=./private-key.pem
PLATFORM_OPENROUTER_API_KEY=sk-or-v1-你的key

将 GitHub App 的私钥文件保存为项目根目录下的 private-key.pem

3. 初始化数据库并启动

# 创建数据库(MySQL 命令行)
mysql -u root -p -e "CREATE DATABASE github_i18n CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"

# 生成 Prisma 客户端 + 建表
npx prisma generate
npx prisma db push

# 启动开发服务器
npm run dev

访问 http://localhost:3123 即可使用。

Docker 部署

docker-compose up -d
docker-compose exec app npx prisma db push

更多细节请查看 本地运行指南人工配置文档

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages