# ✨ Magic Resume ✨ [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![TanStack Start](https://img.shields.io/badge/TanStack_Start-latest-black) ![Framer Motion](https://img.shields.io/badge/Framer_Motion-10.0-purple)

[简体中文](./README.zh-CN.md) | 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 - 🚀 Built with TanStack Start - 💫 Smooth animations (Framer Motion) - 🎨 Custom theme support - 📱 Responsive design - 🌙 Dark mode - 📤 Export to PDF - 🔄 Real-time preview - 💾 Auto-save - 🔒 Local storage ## 🛠️ Tech Stack - TanStack Start - TypeScript - Motion - Tiptap - Tailwind CSS - Zustand - Shadcn/ui - Lucide Icons ## 🚀 Quick Start 1. Clone the project ```bash git clone git@github.com:JOYCEQL/magic-resume.git cd magic-resume ``` 2. Install dependencies ```bash pnpm install ``` 3. Start development server ```bash pnpm dev ``` 4. Open browser and visit `http://localhost:3000` ## 📦 Build and Deploy ```bash pnpm build ``` ## 🐳 Docker Deployment ### Docker Compose 1. Ensure you have Docker and Docker Compose installed 2. Run the following command in the project root directory: ```bash docker compose up -d ``` This will: - Automatically build the application image - Start the container in the background ## 📝 License and Commercial Use The source code of this project is open-sourced under the **Apache 2.0** license, but with **strict commercial use restrictions**: - **Free for Personal Use**: Free to use purely for personal, non-commercial purposes (e.g., personal learning, creating your own resume). - **Commercial License Required**: Unauthorized commercial use is strictly prohibited. Any organization or individual that provides it as a service (SaaS/PaaS, etc.) to the public for profit, uses it for enterprise commercial operations, or conducts secondary commercial development, **must obtain a commercial license, regardless of whether the source code has been modified**. Please see the [LICENSE](LICENSE) file for detailed terms. ## 🗺️ Roadmap - [x] AI-assisted writing - [x] Multi-language support - [ ] Support for more resume templates - [ ] Support for more export formats - [ ] Import PDF, Markdown, etc. - [x] Custom model - [x] Auto one page - [ ] Online resume hosting ## 📈 Star History

## 📞 Contact You can follow the latest updates via: - Author: Siyue - X: @GuangzhouY81070 - Discord: Join our community https://discord.gg/9mWgZrW3VN - Email: 18806723365@163.com - WeChat Group: Scan to join our developer community

- Project Homepage: https://github.com/JOYCEQL/magic-resume ## 🌟 Support If you find this project helpful, please give it a star ⭐️