ai-space/magic-resume
3
0
Fork 0
mirror of https://github.com/JOYCEQL/magic-resume.git synced 2026-07-03 14:07:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: readme.md

Browse Source
This commit is contained in:
JOYCEQL
2024-12-27 12:58:48 +08:00
committed by qingchen
parent 3ccb614e46
commit ed12aba86c
2 changed files with 149 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+45 -49
View File
@@ -5,28 +5,30 @@
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
![Next.js](https://img.shields.io/badge/Next.js-14.0-black)
![Framer Motion](https://img.shields.io/badge/Framer_Motion-10.0-purple)
</div>
Magic Resume 是一个现代化的在线简历编辑器，让创建专业简历变得简单有趣。基于 Next.js 和 Framer Motion 构建，支持实时预览和自定义主题。
## 📸 项目截图
[English](./README.md) | [简体中文](./README.zh-CN.md)
</div>
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
![256shots_so](https://github.com/user-attachments/assets/b07d89d8-56da-4df5-b66f-61dc3568fb0a)
## ✨ 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
## ✨ 特性
- 🚀 基于 Next.js 14+ 构建
- 💫 流畅的动画效果 (Framer Motion)
- 🎨 自定义主题支持
- 📱 响应式设计
- 🌙 深色模式
- 📤 导出为 PDF
- 🔄 实时预览
- 💾 自动保存
- 🔒 本地存储
## 🛠️ 技术栈
## 🛠️ Tech Stack
- Next.js 14+
- TypeScript
@@ -35,74 +37,68 @@ Magic Resume 是一个现代化的在线简历编辑器，让创建专业简历
- Shadcn/ui
- Lucide Icons
## 🚀 快速开始
## 🚀 Quick Start
1. 克隆项目
1. Clone the project
```bash
git clone https://github.com/yourusername/magic-resume.git
cd magic-resume/fronted
```
2. 安装依赖
2. Install dependencies
```bash
pnpm install
```
3. 启动开发服务器
3. Start development server
```bash
pnpm dev
```
4. 打开浏览器访问 `http://localhost:3000`
4. Open browser and visit `http://localhost:3000`
## 📦 构建部署
## 📦 Build and Deploy
```bash
pnpm -F fronted build
```
## 🤝 贡献指南
## 🤝 Contributing
1. Fork 本项目
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交改动 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 提交 Pull Request
1. Fork the project
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## 📝 开源协议
## 📝 License
本项目采用 Apache 2.0 协议 - 查看 [LICENSE](LICENSE) 了解详情
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details
## 🙏 鸣谢
## 🙏 Acknowledgments
- [Next.js](https://nextjs.org/)
- [Framer Motion](https://www.framer.com/motion/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Shadcn/ui](https://ui.shadcn.com/)
## 🗺️ Roadmap
- [ ] Support more resume templates
- [ ] Multi-language support
- [ ] AI-assisted writing
- [ ] Resume scoring system
- [ ] Online resume hosting
## 📞 Contact
## 🗺️ 路线图
- [ ] 支持更多简历模板
- [ ] 多语言支持
- [ ] AI 辅助编写
- [ ] 简历评分系统
- [ ] 在线简历托管
## 📞 联系方式
- 作者：JOYCEQL
- 邮箱：18806723365@163.com
- 项目主页：https://github.com/JOYCEQL/magic-resume](https://github.com/JOYCEQL/magic-resume
## 🌟 支持项目
如果这个项目对你有帮助，欢迎点个 star ⭐️
- Author: JOYCEQL
- Email: 18806723365@163.com
- Project Homepage: https://github.com/JOYCEQL/magic-resume](https://github.com/JOYCEQL/magic-resume
## 🌟 Support
If you find this project helpful, please give it a star ⭐️
README.zh-CN.md
+104
View File
@@ -0,0 +1,104 @@
<div align="center">
# ✨ Magic Resume ✨
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
![Next.js](https://img.shields.io/badge/Next.js-14.0-black)
![Framer Motion](https://img.shields.io/badge/Framer_Motion-10.0-purple)
[English](./README.md) | [简体中文](./README.zh-CN.md)
</div>
Magic Resume 是一个现代化的在线简历编辑器，让创建专业简历变得简单有趣。基于 Next.js 和 Framer Motion 构建，支持实时预览和自定义主题。
## 📸 项目截图
![256shots_so](https://github.com/user-attachments/assets/b07d89d8-56da-4df5-b66f-61dc3568fb0a)
## ✨ 特性
- 🚀 基于 Next.js 14+ 构建
- 💫 流畅的动画效果 (Framer Motion)
- 🎨 自定义主题支持
- 📱 响应式设计
- 🌙 深色模式
- 📤 导出为 PDF
- 🔄 实时预览
- 💾 自动保存
- 🔒 本地存储
## 🛠️ 技术栈
- Next.js 14+
- TypeScript
- Framer Motion
- Tailwind CSS
- Shadcn/ui
- Lucide Icons
## 🚀 快速开始
1. 克隆项目
```bash
git clone https://github.com/yourusername/magic-resume.git
cd magic-resume/fronted
```
2. 安装依赖
```bash
pnpm install
```
3. 启动开发服务器
```bash
pnpm dev
```
4. 打开浏览器访问 `http://localhost:3000`
## 📦 构建部署
```bash
pnpm -F fronted build
```
## 🤝 贡献指南
1. Fork 本项目
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交改动 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 提交 Pull Request
## 📝 开源协议
本项目采用 Apache 2.0 协议 - 查看 [LICENSE](LICENSE) 了解详情
## 🙏 鸣谢
- [Next.js](https://nextjs.org/)
- [Framer Motion](https://www.framer.com/motion/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Shadcn/ui](https://ui.shadcn.com/)
## 🗺️ 路线图
- [ ] 支持更多简历模板
- [ ] 多语言支持
- [ ] AI 辅助编写
- [ ] 简历评分系统
- [ ] 在线简历托管
## 📞 联系方式
- 作者：JOYCEQL
- 邮箱：18806723365@163.com
- 项目主页：https://github.com/JOYCEQL/magic-resume](https://github.com/JOYCEQL/magic-resume
## 🌟 支持项目
如果这个项目对你有帮助，欢迎点个 star ⭐️