magic-resume README

The project's README from github.com/JOYCEQL/magic-resume. As one markdown file: README.md.

✨ Magic Resume ✨

License TanStack Start Framer Motion

Magic Resume | Trendshift

简体中文 | English

Magic Resume is a modern online resume editor that makes creating professional resumes simple and enjoyable. Built with TanStack Start and Framer Motion, it supports real-time preview and custom themes.

📸 Screenshots

336_1x_shots_so

✨ Features

🛠️ Tech Stack

🚀 Quick Start

  1. Clone the project
git clone [email protected]:JOYCEQL/magic-resume.git
cd magic-resume
  1. Install dependencies
pnpm install
  1. Start development server
pnpm dev
  1. Open browser and visit http://localhost:3000

📦 Build and Deploy

pnpm build

AI provider networking

Cloudflare Workers use the platform's native fetch and do not need an application-level proxy. For Node.js or Docker deployments in regions that cannot directly reach OpenAI, Gemini, or Anthropic, set AI_PROXY_URL. HTTPS_PROXY and HTTP_PROXY are also supported as fallbacks.

AI_PROXY_URL=http://127.0.0.1:7890

DeepSeek, Qwen, and Doubao continue to use a direct connection.

🐳 Docker Deployment

Docker Compose

  1. Ensure you have Docker and Docker Compose installed

  2. Run the following command in the project root directory:

docker compose up -d

This will:

📝 License and Usage Restrictions

The source code of this project is released under the Apache 2.0 license with an additional non-commercial use restriction:

Please see the LICENSE file for detailed terms.

🗺️ Roadmap

📈 Star History

Star History Chart

📞 Contact

You can follow the latest updates via:

🌟 Support

If you find this project helpful, please give it a star ⭐️

❤️ Sponsors

Sponsors

If you sponsored this project but are not listed here, please contact me.

@yj147 @someone1128

magic-resume (JOYCEQL/magic-resume)

Searching Database…

这是什么?Magic Resume 是一款免费的在线 AI 简历编辑器,让你轻松愉快地做出专业简历——它在 magicv.art 上运行,源码托管在 GitHub 上。
这是在浏览器里直接用的网站,还是需要自己部署的东西?两者都可以。官方托管版本在 magicv.art 上,你也可以自己部署:仓库提供了 Docker 和 Docker Compose 配置,以及一个 Node.js 启动脚本。
我在本地怎么把它跑起来?克隆仓库,安装依赖并启动开发服务器(dev 脚本会运行 vite dev),然后在浏览器里打开即可。如果要部署,需要先构建,再运行启动脚本(node server.mjs),也可以用 Docker Compose。
它可以接入哪些 AI 服务商?支持 OpenAI、Gemini 和 Anthropic,DeepSeek、通义千问(Qwen)和豆包可以直连,也支持自定义模型。无法直连这些服务商的地区可以设置 AIPROXYURL 或 HTTP(S) 代理环境变量。
我的简历数据会存到哪里?存在你的浏览器里——编辑器会自动保存到本地存储并实时预览修改,所以你的简历保存在你自己的电脑上,而不是账号服务器上。
我可以用它做商业用途吗,比如收费的简历服务?不可以。代码采用 Apache 2.0 协议并附加了非商业限制:个人使用免费,但将其作为付费服务、SaaS/PaaS 运营、转售或商业性二次开发都在禁止之列,即使是修改过的版本也一样。
它是用什么技术做的?上层基于 TanStack Start 和 TypeScript,动画用 Framer Motion,编辑器用 Tiptap,样式用 Tailwind CSS,状态管理用 Zustand,组件则使用 Shadcn/ui 和 Lucide Icons。
我的简历内容总是溢出到第二页——它能解决吗?可以——'自动排版为单页'(Auto one page)已在路线图中标记为完成,编辑器可以自动把你的内容排进一页。
我能按照自己的喜好调整简历的样式吗?可以,内置了自定义主题,界面支持深色模式,路线图中还计划提供更多简历模板。页面布局也是响应式的,在手机上也能正常使用。
Creator
JOYCEQL
Size
257.9 MB
Stars
11.1K
Age
2y
Commits · 90 Days