mirror of
https://github.com/JOYCEQL/magic-resume.git
synced 2026-06-01 23:38:48 +02:00
JOYCEQL
158 lines
4.3 KiB
Markdown
158 lines
4.3 KiB
Markdown
<div align="center">
|
|
|
|
# ✨ Magic Resume ✨
|
|
|
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
|
|
|
|
|
|
<a href="https://trendshift.io/repositories/13077" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13077" alt="Magic Resume | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
|
|
|
[简体中文](./README.zh-CN.md) | English
|
|
|
|
</div>
|
|
|
|
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
|
|
|
|
<img width="1920" height="1440" alt="336_1x_shots_so" src="https://github.com/user-attachments/assets/18969a17-06f8-4a4b-94eb-284ba8442620" />
|
|
|
|
|
|
## ✨ 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
|
|
|
|
<a href="https://star-history.com/#JOYCEQL/magic-resume&Date">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=JOYCEQL/magic-resume&type=Date&theme=dark" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=JOYCEQL/magic-resume&type=Date" />
|
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=JOYCEQL/magic-resume&type=Date" />
|
|
</picture>
|
|
</a>
|
|
|
|
## 📞 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 ⭐️
|
|
|
|
## ❤️ Sponsors
|
|
|
|
<div align="center">
|
|
<h3>Sponsors</h3>
|
|
<p>If you sponsored this project but are not listed here, please contact me.</p>
|
|
<p>
|
|
<a href="https://github.com/yj147">
|
|
<img src="https://github.com/yj147.png?size=40" width="40" height="40" alt="@yj147" />
|
|
</a>
|
|
<a href="https://github.com/someone1128">
|
|
<img src="https://github.com/someone1128.png?size=40" width="40" height="40" alt="@someone1128" />
|
|
</a>
|
|
<!-- Add more sponsors here:
|
|
<a href="https://github.com/<username>">
|
|
<img src="https://github.com/<username>.png?size=40" width="40" height="40" alt="@<username>" />
|
|
</a>
|
|
-->
|
|
</p>
|
|
</div>
|