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 Featured|HelloGitHub

简体中文 | 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.

Sponsored by Offerin AI - AI interview and assessment assistant

❤️ Other Sponsors

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

Sponsor Amount (CNY)
@fbitalk @fbitalk ¥20
@yj147 @yj147 ¥10
@someone1128 @someone1128 ¥10

📸 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

OrcaRouter (optional AI provider)

Select OrcaRouter in AI Providers, register through the Magic Resume referral link, then sign in with OrcaRouter or enter your own API key. Fetch the model list, select a model, and test the connection.

This is a partner referral link. Magic Resume may earn a commission on eligible usage by referred sign-ups. Other providers remain available. OAuth sign-in also carries the same referral code for new sign-ups during authorization.

App usage attribution is separate from sign-up referral attribution. Obtain the real app_id from the partner console's Integration page, set VITE_ORCA_APP_ID at build time, and register the exact deployment callback URL, such as https://magicv.art/auth/orcarouter/callback. Local development uses http://localhost:3000/auth/orcarouter/callback. Without an app_id, app usage attribution is not configured. This variable is a public application identifier, never an API key. See the OrcaRouter partner app documentation.

For local development, set VITE_ORCA_APP_ID in .env.local and restart the dev server. For GitHub Actions, add the repository variable under Settings → Secrets and variables → Actions → Variables; both Cloudflare and Docker publishing pass it at build time. Docker Compose reads the build argument from the shell or .env. For a direct build, use docker build --build-arg VITE_ORCA_APP_ID="$VITE_ORCA_APP_ID" -t magic-resume .. This identifier is embedded in the frontend build; setting it only on a running container has no effect. Leave it unset until the real value is available.

📦 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 ⭐️

magic-resume (JOYCEQL/magic-resume)

tanstack
Searching Database…

What is this?Magic Resume is a free online AI resume editor that makes creating a professional resume simple and enjoyable — it runs at magicv.art, with the source available on GitHub.
Is this a website I use in the browser, or something I have to host myself?Both. The official hosted version lives at magicv.art, and you can also self-host it: the repo ships Docker and Docker Compose setup plus a Node.js start script.
How do I get it running locally?Clone the repo, install the dependencies and start the dev server (the dev script runs vite dev), then open it in your browser. For deployment there is a build step, a start script (node server.mjs) and Docker Compose.
Which AI providers can I hook it up to?OpenAI, Gemini and Anthropic are supported, DeepSeek, Qwen and Doubao connect directly, and custom models are supported too. Regions that cannot reach the providers directly can set AIPROXYURL or HTTP(S) proxy variables.
Where does my resume data end up?In your browser — the editor auto-saves to local storage and previews changes in real time, so your resume lives on your machine rather than on an account server.
Can I use it for something commercial, like a paid resume service?No. The code is Apache 2.0 with an added non-commercial restriction: personal use is free, but running it as a paid service, SaaS/PaaS, resale or commercial secondary development is prohibited, even with modifications.
What is it built with?TanStack Start and TypeScript on top, Framer Motion for animations, Tiptap for the editor, Tailwind CSS for styling, Zustand for state, and Shadcn/ui with Lucide Icons for components.
My resume keeps spilling onto a second page — can it help?Yes — 'Auto one page' is marked complete on the roadmap, so the editor can automatically fit your content onto a single page.
Can I restyle the resume to match my taste?Yes, custom themes are built in, the interface has dark mode, and more resume templates are planned on the roadmap. The layout is also responsive, so it works on phones.
Creator
JOYCEQL
Size
341.4 MB
Stars
11.5K
Age
2y
Commits · 90 Days