JOYCEQL/magic-resume

What it is

Magic Resume is an online resume editor. It's a web app where you can write, edit, and style a professional resume in your browser, with a live preview as you type.

Core features (from the README)

Real-time preview — see changes as you make them
Custom themes — change the look of your resume
Dark mode — a dark color scheme option
Export to PDF — download your finished resume as a PDF
Auto-save — your work is saved automatically
Local storage — data is kept in your browser, not on a server
Responsive design — works on different screen sizes
Smooth animations — powered by Framer Motion
AI-assisted writing — listed as a completed roadmap item
Multi-language support — listed as completed
Import PDF, Markdown, etc. — listed as completed
Custom model — listed as completed
Auto one page — listed as completed

Tech stack

The project is built with: TanStack Start (a React framework), TypeScript, Motion (animation library), Tiptap (rich text editor), Tailwind CSS (styling), Zustand (state management), Shadcn/ui (UI components), and Lucide Icons.

How to run it locally

Clone the repository: git clone git@github.com:JOYCEQL/magic-resume.git
Install dependencies: pnpm install
Start the dev server: pnpm dev
Open http://localhost:3000 in your browser

Deployment options

Docker Compose: run docker compose up -d in the project root to build and start the app in a container.
Cloudflare Workers: supported (uses native fetch, no proxy needed).
Node.js/Docker: if your region can't reach AI providers directly (OpenAI, Gemini, Anthropic), you can set an AI_PROXY_URL or HTTPS_PROXY/HTTP_PROXY environment variable. DeepSeek, Qwen, and Doubao always use a direct connection.

Optional AI provider: OrcaRouter

You can select OrcaRouter as an AI provider. To use it, you register through a referral link in the README, then either sign in with OrcaRouter or enter your own API key. The README notes this is a partner referral link — Magic Resume may earn a commission on eligible usage from referred sign-ups. Other AI providers remain available.

There's also an optional VITE_ORCA_APP_ID build-time variable for app-usage attribution. It's a public app identifier (not a secret key), and it must be set at build time — setting it on a running container has no effect.

License and usage restrictions

The source code is released under Apache 2.0 with an additional non-commercial restriction:

Free for personal use — learning, making your own resume, etc.
Commercial use prohibited — no paid services (SaaS/PaaS), enterprise commercial operations, resale, or secondary commercial development, even if you modify the code.

Roadmap status

Completed: AI-assisted writing, multi-language support, more export formats, import PDF/Markdown, custom model, auto one page.

Not yet done: more resume templates, online resume hosting.

Project details

Author: Siyue
Contact: X (@GuangzhouY81070), Discord community, email (18806723365@163.com)
Homepage: https://github.com/JOYCEQL/magic-resume
Sponsors: Two listed — @yj147 and @someone1128

Notes

The README includes a star-history chart and a Trendshift badge, indicating the project has some community traction.
The README does not describe how the resume editor itself works in detail (e.g., specific editing interactions), nor does it list pricing, a hosted demo URL, or detailed API documentation.