magic-resume/README.en-US.md

✨ Magic Resume ✨

简体中文 | English

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

📸 Screenshots

✨ Features

• 🚀 Built with Next.js 14+
• 💫 Smooth animations (Framer Motion)
• 🎨 Custom theme support
• 📱 Responsive design
• 🌙 Dark mode
• 📤 Export to PDF
• 🔄 Real-time preview
• 💾 Auto-save
• 🔒 Local storage

🛠️ Tech Stack

• Next.js 14+
• TypeScript
• Motion
• Tiptap
• Tailwind CSS
• Zustand
• Shadcn/ui
• Lucide Icons

🚀 Quick Start

1. Clone the project

git clone git@github.com:JOYCEQL/magic-resume.git
cd magic-resume

2. Install dependencies

pnpm install

3. Start development server

pnpm dev

4. Open browser and visit http://localhost:3000

📦 Build and Deploy

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:

docker compose up -d

This will:

• Automatically build the application image
• Start the container in the background

📝 License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details

🗺️ Roadmap

• AI-assisted writing
• Multi-language support
• Support for more resume templates
• Support for more export formats
• Import PDF, Markdown, etc.
• Custom model
• Smart single page
• Online resume hosting

📞 Contact

You can follow the latest updates via:

• Author: Siyue
• X: @GuangzhouY81070
• Discord: Join our community https://discord.gg/9mWgZrW3VN
• Email: 18806723365@163.com
• Project Homepage: https://github.com/JOYCEQL/magic-resume

🌟 Support

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