Files
magic-resume/README.zh-CN.md
T
2026-03-19 23:21:11 +08:00

140 lines
3.6 KiB
Markdown

<div align="center">
# ✨ 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)
<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>
简体中文 | [English](./README.md)
</div>
Magic Resume 是一个现代化的在线简历编辑器,让创建专业简历变得简单有趣。基于 TanStack Start 和 Motion 构建,支持实时预览和自定义主题。
## 📸 项目截图
<img width="1920" height="1440" alt="85_1x_shots_so" src="https://github.com/user-attachments/assets/4667e49a-7bf2-4379-9390-725e42799dc7" />
## ✨ 特性
- 🚀 基于 TanStack Start 构建
- 💫 流畅的动画效果 (Motion)
- 🎨 自定义主题支持
- 🌙 深色模式
- 📤 导出为 PDF
- 🔄 实时预览
- 💾 自动保存
- 🔒 硬盘级存储
## 🛠️ 技术栈
- TanStack Start
- TypeScript
- Motion
- Tiptap
- Tailwind CSS
- Zustand
- Shadcn/ui
- Lucide Icons
## 🚀 快速开始
1. 克隆项目
```bash
git clone git@github.com:JOYCEQL/magic-resume.git
cd magic-resume
```
2. 安装依赖
```bash
pnpm install
```
3. 启动开发服务器
```bash
pnpm dev
```
4. 打开浏览器访问 `http://localhost:3000`
## 📦 构建打包
```bash
pnpm build
```
## 🐳 Docker 部署
### Docker Compose
1. 确保你已经安装了 Docker 和 Docker Compose
2. 在项目根目录运行:
```bash
docker compose up -d
```
这将会:
- 自动构建应用镜像
- 在后台启动容器
## 📝 开源协议与商业授权
本项目源代码基于 **Apache 2.0** 协议开源,但附带**严格的商业使用限制**:
- **个人免费**:仅限个人非商业目的(如个人学习交流、制作个人简历)免费使用。
- **商用需授权**:严禁未经授权的商业化使用。任何组织或个人,若将其作为服务(SaaS/PaaS等)向公众提供以获取利益,或作为企业商业运营使用,或进行二次商业化开发,**无论是否修改源代码,均须获取商业授权**。
详情请查看 [LICENSE](LICENSE) 文件。
## 🗺️ 路线图
- [x] AI 辅助编写
- [x] 多语言支持
- [ ] 支持更多简历模板
- [ ] 更多格式导出
- [x] 自定义模型
- [x] 自动一页纸
- [ ] 导入 PDF, Markdown 等
- [ ] 在线简历托管
## 📈 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>
## 📞 联系方式
可以通过以下方式关注最新动态:
- 作者:SiYue
- X: @GuangzhouY81070
- Discord: 欢迎加入群组 https://discord.gg/9mWgZrW3VN
- 邮箱:18806723365@163.com
- 微信群:扫码加入开发交流群
<img src="./images/wechat.jpg" width="200" alt="WeChat Group">
- 项目主页:https://github.com/JOYCEQL/magic-resume
## 🌟 支持项目
<img src="https://github.com/JOYCEQL/picx-images-hosting/raw/master/pintu-fulicat.com-1741081632544.26lmg2uc2m.webp" width="320" alt="图片描述">