Content
# GitHub Repository AI Document Translation Platform
> Author: [Programmer Yupi](https://yuyuanweb.feishu.cn/wiki/Abldw5WkjidySxkKxU2cQdAtnah)
>
> This project is a teaching project that provides complete video tutorials + text tutorials + resume writing + interview question solutions + Q&A services to help you improve your project capabilities and add highlights to your resume!
>
> ⭐️ Join the project series learning: [Join CodeFather](https://www.codefather.cn/vip)
## I. Project Introduction
This is a set of project tutorials centered around **AI programming practice**, based on Next.js + GitHub App + OpenRouter, using AI programming to develop a GitHub repository AI document translation SaaS platform from scratch, allowing you to experience the complete workflow of AI Vibe Coding and learn to create truly usable, deployable, and profitable products with AI!
📺 Project introduction video, quickly view the finished product effect: https://bilibili.com/video/BV1mAAmzqEfP
Enter any GitHub repository address, and AI will automatically translate documents into multiple languages. When the base language content changes, **automatic incremental synchronization translation** generates PR, waiting for the repository owner to merge, without manual intervention throughout the process.
### Why create this project?
Yupi open-sourced an AI programming tutorial repository [ai-guide](https://github.com/liyupi/ai-guide), which contains hundreds of Chinese tutorial documents. To allow overseas users to see it, I hope to translate the repository into multiple languages, but manual translation costs too much, and GitHub Actions requires custom configuration...
So, **create a more universal tool**.
This is the starting point of the GitHub Global project: enter any GitHub repository address, AI automatically translates documents into multiple languages, and when the base language content changes, **automatic incremental synchronization translation** generates PR, waiting for the repository owner to merge, without manual intervention throughout the process.
Zero configuration, one-click translation, let your GitHub project go global!
### 6 Core Capabilities
1) Log in with GitHub account, one-click login, based on GitHub App to achieve secure login and authorization.
2) Import GitHub repository, enter address to automatically pull repository information.
3) Configure translation, visual selection of translation range and target language (supporting 20 mainstream languages).
4) One-click execution translation, real-time display progress, automatic creation of PR after translation.
Repository owners can choose whether to merge this translation, convenient and safe:
5) Automatically trigger incremental translation, once enabled, each Push will automatically translate changed documents.
6) Custom large model and API Key, supporting GPT, Claude, Gemini, DeepSeek and other mainstream models.
## II. Project Advantages
This project has a novel topic, keeping up with the AI programming era, and is oriented towards **real SaaS product development**, which is different from the common CRUD projects. The project content is refined, **can be learned in less than a week**, and takes you through the complete workflow of AI programming, greatly increasing the competitiveness of your resume and job search!
Rich technology, covering the entire AI programming chain:
From this project, you can learn:
- How to use AI for demand research and generate professional "Demand Specification Document"?
- How to use multiple AI in parallel to develop front-end and back-end simultaneously?
- How to connect with GitHub App and achieve secure OAuth authorization and repository operation?
- How to access OpenRouter and uniformly connect to hundreds of AI large models?
- How to use GitHub API to obtain repository file tree, submit files, and create PR?
- How to implement event-driven automatic translation through GitHub Webhook?
- How to use internal network penetration tools to debug Webhook callback locally?
- How to deploy Next.js full-stack project with Vercel and quickly go online?
- How to perform code review, version control, and problem repair in the AI development process?
- How to identify competitive product differentiation opportunities and design truly competitive products?
### Yupi Series Project Advantages
Yupi's original projects are mainly **practical**, using **full live streaming** to **from 0 to 1** lead, from demand analysis, technical selection, project design, project initialization, Demo writing, front-end and back-end development implementation, project optimization, deployment and launch, etc., each link I **from theory to practice** to explain clearly, each detail does not let go!
Compared to online tutorials, Yupi project series advantages: from learning knowledge => practicing projects => reviewing notes => project Q&A => resume writing => interview question solutions of a complete service
CodeFather has **20+ sets of project tutorials!** Each project has different learning focuses, almost all are front-end + back-end **full-stack** projects, and there are also many AI application development projects.
For details, see: [https://codefather.cn/course](https://www.codefather.cn/course) (on the right side of the page, there are tutorial recommendations and learning suggestions)
Previous project introduction video: [https://bilibili.com/video/BV1YvmbYbEgS](https://www.bilibili.com/video/BV1YvmbYbEgS/)
Yupi's projects have helped many students get high-paying offers from top companies:
## III. More Introduction
Function modules:
Architecture design:
## IV. Quick Start
> For detailed step-by-step tutorial, please refer to [Local Running Guide](./docs/%E6%9C%AC%E5%9C%B0%E8%BF%90%E8%A1%8C%E6%8C%82%E5%BE%AE.md)
### Prerequisites
- Node.js >= 20
- MySQL >= 8.0
- A [GitHub App](https://github.com/settings/apps/new) (for login and repository operation)
- An [OpenRouter API Key](https://openrouter.ai/keys) (for AI translation)
### 1. Clone and Install Dependencies
```bash
git clone https://github.com/liyupi/github-global.git
cd github-global
npm install
```
### 2. Configure Environment Variables
```bash
# Create environment variable files (keep the content of both files consistent)
cp .env.example .env
cp .env.example .env.local
```
Edit `.env` and `.env.local`, fill in your configuration:
```bash
DATABASE_URL=mysql://root:your_password@localhost:3306/github_global
NEXTAUTH_URL=http://localhost:3123
AUTH_SECRET=random_string_at_least_32_bits
GITHUB_APP_ID=your_AppID
GITHUB_APP_CLIENT_ID=your_ClientID
GITHUB_APP_CLIENT_SECRET=your_ClientSecret
GITHUB_APP_PRIVATE_KEY_PATH=./private-key.pem
PLATFORM_OPENROUTER_API_KEY=sk-or-v1-your_key
```
Save the GitHub App private key file as `private-key.pem` in the project root directory.
### 3. Initialize Database and Start
```bash
# Create database (MySQL command line)
mysql -u root -p -e "CREATE DATABASE github_global CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
# Generate Prisma client + create table
npx prisma generate
npx prisma db push
# Start development server
npm run dev
```
Access **http://localhost:3123** to use.
### Docker Deployment
```bash
docker-compose up -d
docker-compose exec app npx prisma db push
```
For more details, see [Local Running Guide](./docs/%E6%9C%AC%E5%9C%B0%E8%BF%90%E8%A1%8C%E6%8C%82%E5%BE%AE.md) and [Manual Configuration Document](./docs/%E4%BA%BA%E5%B7%A5%E9%85%8D%E7%BD%AE%E6%89%87%E6%96%87%E6%A1%A3.md).
## Join Project Learning
CodeFather has **20+ sets of project tutorials!** Each project has different learning focuses, almost all are front-end + back-end **full-stack** projects, and there are also many AI application development projects.
Welcome to join [CodeFather](https://www.codefather.cn/vip). After joining, not only can you follow this project, but also **20+ original project tutorials** can be watched unlimitedly. You can also enjoy more original technical information, learning and job search guidance, and hundreds of interview playback videos to start your programming takeoff journey~
🧧 Help new project learning, distribute **limited-time CodeFather discount coupons**, scan the code to receive coupons and join. Within three days of joining, if you are not satisfied, you can get a full refund. Welcome to join the experience, limited spots available, come and learn!
<img width="404" alt="image" src="https://github.com/user-attachments/assets/56411098-b60e-4267-8ba2-4ebc5d416afc" />
Less than 1 day, 1 block, it's an absolute worthwhile investment in yourself! After becoming a CodeFather member, you can unlock more than 20 sets of project tutorials and materials, and learn on PC website and APP, as shown:
