https://github.com/linmoqc/magic-resume

Magic Resume 是一个由 AI 驱动的智能简历优化器。它基于 Next.js 构建，旨在帮助用户根据目标岗位（JD）的要求，智能地分析、优化个人简历，并提供专业建议。
https://github.com/linmoqc/magic-resume

ai langchain langgraph-js next react typescript

Last synced: 10 months ago
JSON representation

Magic Resume 是一个由 AI 驱动的智能简历优化器。它基于 Next.js 构建，旨在帮助用户根据目标岗位（JD）的要求，智能地分析、优化个人简历，并提供专业建议。

Host: GitHub
URL: https://github.com/linmoqc/magic-resume
Owner: LinMoQC
License: mit
Created: 2025-06-06T10:20:49.000Z (about 1 year ago)
Default Branch: master
Last Pushed: 2025-07-09T09:38:26.000Z (12 months ago)
Last Synced: 2025-08-06T11:15:01.551Z (11 months ago)
Topics: ai, langchain, langgraph-js, next, react, typescript
Language: TypeScript
Homepage: https://magic-resume.cn
Size: 5.66 MB
Stars: 21
Watchers: 1
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

AI 驱动的现代化简历构建器

[![License](https://img.shields.io/github/license/LinMoQC/Magic-Resume?style=flat-square)](https://github.com/LinMoQC/Magic-Resume/blob/master/LICENSE) [![Stars](https://img.shields.io/github/stars/LinMoQC/Magic-Resume?style=flat-square)](https://github.com/LinMoQC/Magic-Resume/stargazers) [![Forks](https://img.shields.io/github/forks/LinMoQC/Magic-Resume?style=flat-square)](https://github.com/LinMoQC/Magic-Resume/network/members) [![Issues](https://img.shields.io/github/issues/LinMoQC/Magic-Resume?style=flat-square)](https://github.com/LinMoQC/Magic-Resume/issues)

---

## 🌟 项目简介

**Magic Resume** 是一款现代化的 AI 驱动简历构建器，采用 Next.js 14 构建。它不仅提供直观的在线编辑体验，还能根据目标职位智能优化简历内容，让您的求职之路更加顺畅。

### ✨ 核心特性

- 🎨 **可视化模板自定义** - 22种精美字体 + 实时颜色/布局调整
- 🤖 **AI 智能优化** - 根据 JD 自动优化简历内容和匹配度
- 📊 **专业分析报告** - Lighthouse 风格的简历健康度分析
- 🌐 **完整国际化** - 中英文界面无缝切换
- 💾 **本地存储优先** - 数据安全，支持多格式导出
- 🎯 **实时预览** - 所见即所得的编辑体验

---

## 🏗️ 技术架构

| 分类 | 技术栈 |
|------|-------|
| **前端框架** | Next.js 14 · React 18 · TypeScript |
| **UI 设计** | Tailwind CSS · Radix UI · shadcn/ui · Framer Motion |
| **AI 能力** | OpenAI API · Tavily Search · LangChain |
| **用户认证** | Clerk · NextAuth (可选) |
| **第三方集成** | GitHub API · 后端服务支持 |
| **状态管理** | Zustand · Immer |
| **富文本** | Tiptap Editor · Dnd Kit |
| **工具链** | ESLint · Husky · Zod |

## 📁 项目结构

```
resume/
├── src/
│ ├── app/ # Next.js App Router
│ │ ├── dashboard/ # 仪表盘页面
│ │ ├── components/ # 全局组件
│ │ └── globals.css # 全局样式
│ ├── templates/ # 简历模板系统
│ │ ├── config/ # 模板配置
│ │ ├── templateLayout/ # 布局组件
│ │ ├── TemplateCustomizer/ # 自定义器组件
│ │ └── renderer/ # 渲染引擎
│ ├── lib/ # 工具库
│ ├── store/ # 状态管理
│ ├── locales/ # 国际化
│ └── prompts/ # AI 提示词
└── public/ # 静态资源
```

## 🚀 快速开始

### 📦 安装与配置

```bash
# 1. 克隆项目
git clone https://github.com/LinMoQC/Magic-Resume.git
cd Magic-Resume

# 2. 安装依赖
npm install

# 3. 配置环境变量
cp .env.local.example .env.local
# 编辑 .env.local 填入您的密钥
```

### 🔑 环境变量配置

创建 `.env.local` 文件进行配置：

```bash
# 必需配置
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_xxx
CLERK_SECRET_KEY=sk_test_xxx

# 可选配置 - Google Analytics
NEXT_PUBLIC_GA_ID=G-XXXXXXXXXX
```

**核心配置项：**

| 配置类别 | 必需性 | 说明 |
|---------|-------|------|
| **Clerk 认证** | ✅ 必需 | 用户登录注册系统 |
| **Google Analytics** | ⚙️ 可选 | 网站流量分析 |
| **后端服务** | ⚙️ 可选 | 完整后端支持 |

### 🏃‍♂️ 运行项目

```bash
# 开发环境
npm run dev

# 生产构建
npm run build && npm run start

# 代码检查
npm run lint
```

打开 [http://localhost:3000](http://localhost:3000) 开始使用！

### 🔧 详细配置指南

📋 Clerk 用户认证配置 (必需)

1. 访问 [Clerk.com](https://clerk.com/) 注册账号
2. 创建新应用，选择认证方式
3. 在 Dashboard → API Keys 获取密钥：
```env
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_xxx
CLERK_SECRET_KEY=sk_test_xxx
```
4. 配置重定向URL（可选）

🤖 AI 功能配置 (可选)

**OpenAI API** - 简历智能优化
1. 访问 [OpenAI Platform](https://platform.openai.com/)
2. 创建 API 密钥
3. 配置：`OPENAI_API_KEY=sk-xxx`

**Tavily API** - 智能搜索增强
1. 访问 [Tavily.com](https://tavily.com/)
2. 注册并获取 API 密钥
3. 配置：`TAVILY_API_KEY=tvly-xxx`

📱 GitHub 集成 (可选)

用于从 GitHub 导入项目数据：
1. 访问 [GitHub Settings → Tokens](https://github.com/settings/tokens)
2. 生成 Personal Access Token
3. 配置：`GITHUB_TOKEN=ghp-xxx`
4. 权限选择：`repo`, `user:email`

🚀 后端服务配置 (可选)

如需使用完整后端功能：
1. 启动后端服务（通常在端口 8000）
2. 配置后端地址：`BACKEND_URL=http://127.0.0.1:8000`
3. 启用后端：`NEXT_PUBLIC_IF_USE_BACKEND=true`
4. 详见后端项目的部署文档

📊 Google Analytics 配置 (可选)

**网站流量分析** - 了解用户行为和网站性能
1. 访问 [Google Analytics](https://analytics.google.com/)
2. 创建账户和媒体资源
3. 获取测量ID：`NEXT_PUBLIC_GA_ID=G-XXXXXXXXXX`

**隐私保护特性**：
- 仅在生产环境启用
- 其他用户部署时不会影响您的数据
- 支持自定义事件追踪

详细配置请参考：[ANALYTICS_SETUP.md](./ANALYTICS_SETUP.md)

🔐 认证系统配置

**Clerk (推荐)** - 现代认证方案
- 完整的用户管理界面
- 多种登录方式支持

**NextAuth (可选)** - 传统认证方案
- 配置：`NEXTAUTH_URL` 和 `NEXTAUTH_SECRET`
- 适用于自定义认证需求

## 💡 功能特性详解

### 🎨 模板自定义系统

**颜色主题**
- 5种快速主题切换
- 6种详细颜色配置
- 实时预览效果

**字体系统**
- 22种精选字体
- 包含现代、手写、科技感字体
- 6级字体大小调节

**布局控制**
- 容器宽度调整 (600-1000px)
- 内边距和间距设置
- 文本行高和字符间距
- 段落和章节间距

**实时保存**
- 自动保存配置差异
- 减少90%存储空间
- 完整的撤销/重做

### 🤖 AI 智能功能

| 功能 | 技术支持 | 描述 |
|-----|---------|------|
| **智能优化** | OpenAI GPT | 根据 JD 自动优化简历内容 |
| **健康分析** | AI 分析引擎 | Lighthouse 风格的专业分析 |
| **引导创建** | 对话式 AI | AI 对话式简历生成 |
| **智能搜索** | Tavily API | 增强的网络搜索能力 |
| **GitHub 集成** | GitHub API | 自动导入项目经历 |

## 📸 产品预览

🎨 模板自定义
🤖 AI 智能优化

💬 AI 对话助手
🎯 文本选择优化

智能模板选择

📊 专业分析
📱 多端适配