README.zh-CN.md

✨ Magic Resume ✨

简体中文 | English

Magic Resume 是一个现代化的在线简历编辑器，让创建专业简历变得简单有趣。基于 TanStack Start 和 Motion 构建，支持实时预览和自定义主题。

📸 项目截图

✨ 特性

• 🚀 基于 TanStack Start 构建
• 💫 流畅的动画效果 (Motion)
• 🎨 自定义主题支持
• 🌙 深色模式
• 📤 导出为 PDF
• 🔄 实时预览
• 💾 自动保存
• 🔒 硬盘级存储

🛠️ 技术栈

• TanStack Start
• TypeScript
• Motion
• Tiptap
• Tailwind CSS
• Zustand
• Shadcn/ui
• Lucide Icons

🚀 快速开始

1. 克隆项目

git clone git@github.com:JOYCEQL/magic-resume.git
cd magic-resume

2. 安装依赖

pnpm install

3. 启动开发服务器

pnpm dev

4. 打开浏览器访问 http://localhost:3000

📦 构建打包

pnpm build

AI 厂商网络配置

Cloudflare Workers 使用平台原生 fetch，无需配置应用层代理。Node.js 或 Docker 部署在无法直连 OpenAI、Gemini、Anthropic 的地区时，可以设置 AI_PROXY_URL；同时兼容 HTTPS_PROXY 和 HTTP_PROXY。

AI_PROXY_URL=http://127.0.0.1:7890

DeepSeek、通义千问和豆包保持直连。

🐳 Docker 部署

Docker Compose

1. 确保你已经安装了 Docker 和 Docker Compose

2. 在项目根目录运行：

docker compose up -d

这将会：

• 自动构建应用镜像
• 在后台启动容器

📝 许可协议与使用限制

本项目源代码基于 Apache 2.0 协议发布，并附带仅限非商业使用的额外限制：

• 个人免费：仅限个人非商业目的（如个人学习交流、制作个人简历）免费使用。
• 禁止商用：不得将本项目用于任何商业目的，包括将其作为收费或营利性服务（如 SaaS/PaaS）对外提供、用于企业商业运营、转售或进行二次商业化开发，无论是否修改源代码。

详情请查看 LICENSE 文件。

🗺️ 路线图

• AI 辅助编写
• 多语言支持
• 支持更多简历模板
• 更多格式导出
• 自定义模型
• 自动一页纸
• 导入 PDF, Markdown 等
• 在线简历托管

📈 Star History

📞 联系方式

可以通过以下方式关注最新动态:

• 作者：SiYue

• X: @GuangzhouY81070

• Discord: 欢迎加入群组 https://discord.gg/9mWgZrW3VN

• 邮箱：18806723365@163.com

• 项目主页：https://github.com/JOYCEQL/magic-resume

🌟 支持项目

❤️ 赞助名单

Sponsors

如果您赞助了本项目，但没展示在这里，请联系我。