1. 项目定位与用途
Magic Resume 是一个现代在线简历编辑器,定位为免费、开源的 AI 驱动工具,旨在让简历创建过程简单且高效。主要用途是帮助用户快速编辑、预览和导出专业简历,支持实时内容更新与多主题切换,适用于个人求职、内容优化等多种场景。
Magic Resume 是一个免费开源 AI 简历编辑器,支持实时预览、多主题模板和 PDF 导出。本页详细介绍项目用途、解决痛点、适用场景、安装步骤、使用方法及技术实现,帮助您快速上手。
Magic Resume 是一个基于 AI 的现代在线简历编辑器,提供实时预览、多主题模板和 PDF 导出,旨在让简历制作过程简单高效。
Magic Resume 是一个现代在线简历编辑器,定位为免费、开源的 AI 驱动工具,旨在让简历创建过程简单且高效。主要用途是帮助用户快速编辑、预览和导出专业简历,支持实时内容更新与多主题切换,适用于个人求职、内容优化等多种场景。
项目解决了传统简历编辑工具操作复杂、反馈延迟、模板选择有限的问题。通过集成 AI 进行语法检查与内容润色,提供多样化专业模板,并实现流畅的实时预览与动画,显著降低了简历制作的门槛,提升了用户体验和编辑效率。
主要适用于个人求职者快速创建专业简历;需要 AI 辅助优化简历内容的用户;多语言(中英文)简历制作需求;以及希望本地存储、自动保存的离线编辑场景。同时,其响应式设计也支持在移动设备上使用。
安装需使用 pnpm 包管理器。首先克隆仓库:git clone [email protected]:JOYCEQL/magic-resume.git,进入目录后执行 pnpm install 安装依赖。开发环境启动命令为 pnpm dev,默认访问 http://localhost:3000。生产构建使用 pnpm build,也可通过 Docker Compose 部署(需安装 Docker 并运行 docker compose up -d)。
启动后进入工作台,使用基于 Tiptap 的富文本编辑器编辑简历内容。通过侧边栏切换不同模板主题(如 classic、modern 等),实时预览效果。利用 AI 功能进行语法检查或内容润色(通过 /grammar 和 /polish API 路由)。点击导出按钮可将简历保存为 PDF。所有修改自动保存至本地存储,刷新页面不会丢失数据。
项目采用 Vite + @tanstack/react-start 框架,基于文件路由组织页面与 API。前端使用 React 18,状态管理通过 Zustand,UI 组件基于 Radix UI 与 HeroUI。AI 功能通过服务端路由实现,支持流式输出并严格约束格式。预览模块在客户端实时计算内容高度与分页,确保打印/导出布局一致。源代码基于 Apache 2.0 许可证,但商业使用需额外授权。
使用 pnpm 包管理器:克隆仓库后,在项目根目录执行 pnpm install 安装依赖,然后运行 pnpm dev 启动开发服务器,最后在浏览器访问 http://localhost:3000。生产环境可使用 pnpm build 构建,或通过 Docker Compose 部署。
源代码基于 Apache 2.0 许可证,但包含严格的商业使用限制:个人非商业用途免费,但任何组织或个人将其作为服务(SaaS/PaaS)提供、用于企业运营或二次商业开发,必须获得商业授权,无论是否修改源代码。详见 LICENSE 文件。
AI 功能通过服务端 API 路由集成 Google Generative AI,提供语法检查(/grammar)和内容润色(/polish)服务。具体是否需付费取决于 Google AI 服务的使用政策,项目本身不收取额外费用,但调用外部 API 可能产生费用。
在编辑界面点击导出按钮即可将简历保存为 PDF 格式。根据 README 的路线图,未来计划支持更多导出格式,但当前版本仅明确提及 PDF 导出。
所有编辑内容自动保存至浏览器本地存储(localStorage),刷新页面不会丢失,确保离线编辑安全。数据仅存储在本地,不会上传至服务器,除非主动使用 AI 功能调用 API。