mirror of
https://github.com/JOYCEQL/magic-resume.git
synced 2026-06-01 23:38:48 +02:00
feat: add English README and update Chinese README links
This commit is contained in:
JOYCEQL
+130
@@ -0,0 +1,130 @@
|
||||
<div align="center">
|
||||
|
||||
# ✨ Magic Resume ✨
|
||||
|
||||
[](https://opensource.org/licenses/Apache-2.0)
|
||||
|
||||
|
||||
|
||||
English | [简体中文](./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
|
||||
|
||||
|
||||
|
||||
## ✨ 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
|
||||
- Framer Motion
|
||||
- Tailwind CSS
|
||||
- Shadcn/ui
|
||||
- Lucide Icons
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
1. Clone the project
|
||||
|
||||
```bash
|
||||
git clone https://github.com/yourusername/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
|
||||
```
|
||||
|
||||
## ⚡ Deploy with Vercel
|
||||
|
||||
You can deploy your own instance of Magic Resume with one click:
|
||||
|
||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FJOYCEQL%2Fmagic-resume)
|
||||
|
||||
## 🐳 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
|
||||
|
||||
### Docker Hub
|
||||
The latest version of Magic Resume is available on Docker Hub:
|
||||
|
||||
|
||||
|
||||
```bash
|
||||
docker pull siyueqingchen/magic-resume
|
||||
```
|
||||
## 📝 License
|
||||
|
||||
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details
|
||||
|
||||
## 🙏 Acknowledgments
|
||||
|
||||
- [Next.js](https://nextjs.org/)
|
||||
- [Shadcn/ui](https://ui.shadcn.com/)
|
||||
- [Zustand](https://zustand-demo.pmnd.rs/)
|
||||
- [Tailwind CSS](https://tailwindcss.com/)
|
||||
- [Framer Motion](https://www.framer.com/motion/)
|
||||
- [Lucide Icons](https://lucide.dev/)
|
||||
|
||||
## 🗺️ Roadmap
|
||||
|
||||
- [x] AI-assisted writing
|
||||
- [x] Multi-language support
|
||||
- [ ] Support for more resume templates
|
||||
- [ ] Support for more export formats
|
||||
- [ ] Smart single page
|
||||
- [ ] Online resume hosting
|
||||
|
||||
## 📞 Contact
|
||||
|
||||
- Author: JOYCEQL
|
||||
- Email: 18806723365@163.com
|
||||
- Project Homepage: https://github.com/JOYCEQL/magic-resume
|
||||
|
||||
## 🌟 Support
|
||||
|
||||
If you find this project helpful, please give it a star ⭐️
|
||||
@@ -1,3 +1,4 @@
|
||||
|
||||
<div align="center">
|
||||
|
||||
# ✨ Magic Resume ✨
|
||||
@@ -6,29 +7,29 @@
|
||||
|
||||
|
||||
|
||||
English | [简体中文](./README.zh-CN.md)
|
||||
[English](./README.en-US.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.
|
||||
Magic Resume 是一个现代化的在线简历编辑器，让创建专业简历变得简单有趣。基于 Next.js 和 Framer Motion 构建，支持实时预览和自定义主题。
|
||||
|
||||
## 📸 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
|
||||
- 🚀 基于 Next.js 14+ 构建
|
||||
- 💫 流畅的动画效果 (Framer Motion)
|
||||
- 🎨 自定义主题支持
|
||||
- 📱 响应式设计
|
||||
- 🌙 深色模式
|
||||
- 📤 导出为 PDF
|
||||
- 🔄 实时预览
|
||||
- 💾 自动保存
|
||||
- 🔒 本地存储
|
||||
|
||||
## 🛠️ Tech Stack
|
||||
## 🛠️ 技术栈
|
||||
|
||||
- Next.js 14+
|
||||
- TypeScript
|
||||
@@ -37,82 +38,94 @@ Magic Resume is a modern online resume editor that makes creating professional r
|
||||
- Shadcn/ui
|
||||
- Lucide Icons
|
||||
|
||||
## 🚀 Quick Start
|
||||
## 🚀 快速开始
|
||||
|
||||
1. Clone the project
|
||||
1. 克隆项目
|
||||
|
||||
```bash
|
||||
git clone https://github.com/yourusername/magic-resume.git
|
||||
cd magic-resume
|
||||
```
|
||||
|
||||
2. Install dependencies
|
||||
2. 安装依赖
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. Start development server
|
||||
3. 启动开发服务器
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
4. Open browser and visit `http://localhost:3000`
|
||||
4. 打开浏览器访问 `http://localhost:3000`
|
||||
|
||||
## 📦 Build and Deploy
|
||||
## 📦 构建打包
|
||||
|
||||
```bash
|
||||
pnpm build
|
||||
pnpm build
|
||||
```
|
||||
|
||||
## ⚡ Deploy with Vercel
|
||||
## ⚡ 使用 Vercel 部署
|
||||
|
||||
You can deploy your own instance of Magic Resume with one click:
|
||||
你可以一键部署自己的 Magic Resume 实例：
|
||||
|
||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FJOYCEQL%2Fmagic-resume)
|
||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FJOYCEQL%2Fmagic-resume)
|
||||
|
||||
## 🐳 Docker Deployment
|
||||
## 🐳 Docker 部署
|
||||
|
||||
### Docker Compose
|
||||
|
||||
1. Ensure you have Docker and Docker Compose installed
|
||||
1. 确保你已经安装了 Docker 和 Docker Compose
|
||||
|
||||
2. Run the following command in the project root directory:
|
||||
2. 在项目根目录运行：
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
### Docker Hub
|
||||
最新版本的 Magic Resume 已经发布在 Docker Hub：
|
||||
|
||||
This will:
|
||||
|
||||
|
||||
- Automatically build the application image
|
||||
- Start the container in the background
|
||||
```bash
|
||||
docker pull siyueqingchen/magic-resume
|
||||
```
|
||||
|
||||
## 📝 License
|
||||
这将会：
|
||||
|
||||
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details
|
||||
- 自动构建应用镜像
|
||||
- 在后台启动容器
|
||||
|
||||
## 🙏 Acknowledgments
|
||||
## 📝 开源协议
|
||||
|
||||
本项目采用 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/)
|
||||
- [Zustand](https://zustand-demo.pmnd.rs/)
|
||||
- [Tailwind CSS](https://tailwindcss.com/)
|
||||
- [Framer Motion](https://www.framer.com/motion/)
|
||||
- [Lucide Icons](https://lucide.dev/)
|
||||
|
||||
## 🗺️ Roadmap
|
||||
## 🗺️ 路线图
|
||||
|
||||
- [x] AI-assisted writing
|
||||
- [x] Multi-language support
|
||||
- [ ] Support for more resume templates
|
||||
- [ ] Online resume hosting
|
||||
- [x] AI 辅助编写
|
||||
- [x] 多语言支持
|
||||
- [ ] 支持更多简历模板
|
||||
- [ ] 更多格式导出
|
||||
- [ ] 智能一页
|
||||
- [ ] 在线简历托管
|
||||
|
||||
## 📞 Contact
|
||||
## 📞 联系方式
|
||||
|
||||
- Author: JOYCEQL
|
||||
- Email: 18806723365@163.com
|
||||
- Project Homepage: https://github.com/JOYCEQL/magic-resume
|
||||
- 作者：JOYCEQL
|
||||
- 邮箱：18806723365@163.com
|
||||
- 项目主页：https://github.com/JOYCEQL/magic-resume
|
||||
|
||||
## 🌟 Support
|
||||
## 🌟 支持项目
|
||||
|
||||
If you find this project helpful, please give it a star ⭐️
|
||||
如果这个项目对你有帮助，欢迎点个 star ⭐️
|
||||
|
||||
-118
@@ -1,118 +0,0 @@
|
||||
<div align="center">
|
||||
|
||||
# ✨ Magic Resume ✨
|
||||
|
||||
[](https://opensource.org/licenses/Apache-2.0)
|
||||
|
||||
|
||||
|
||||
[English](./README.md) | 简体中文
|
||||
|
||||
</div>
|
||||
|
||||
Magic Resume 是一个现代化的在线简历编辑器，让创建专业简历变得简单有趣。基于 Next.js 和 Framer Motion 构建，支持实时预览和自定义主题。
|
||||
|
||||
## 📸 项目截图
|
||||
|
||||
|
||||
|
||||
## ✨ 特性
|
||||
|
||||
- 🚀 基于 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
|
||||
```
|
||||
|
||||
2. 安装依赖
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. 启动开发服务器
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
4. 打开浏览器访问 `http://localhost:3000`
|
||||
|
||||
## 📦 构建打包
|
||||
|
||||
```bash
|
||||
pnpm build
|
||||
```
|
||||
|
||||
## ⚡ 使用 Vercel 部署
|
||||
|
||||
你可以一键部署自己的 Magic Resume 实例：
|
||||
|
||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FJOYCEQL%2Fmagic-resume)
|
||||
|
||||
## 🐳 Docker 部署
|
||||
|
||||
### Docker Compose
|
||||
|
||||
1. 确保你已经安装了 Docker 和 Docker Compose
|
||||
|
||||
2. 在项目根目录运行：
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
这将会：
|
||||
|
||||
- 自动构建应用镜像
|
||||
- 在后台启动容器
|
||||
|
||||
## 📝 开源协议
|
||||
|
||||
本项目采用 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/)
|
||||
|
||||
## 🗺️ 路线图
|
||||
|
||||
- [x] AI 辅助编写
|
||||
- [x] 多语言支持
|
||||
- [ ] 支持更多简历模板
|
||||
- [ ] 在线简历托管
|
||||
|
||||
## 📞 联系方式
|
||||
|
||||
- 作者：JOYCEQL
|
||||
- 邮箱：18806723365@163.com
|
||||
- 项目主页：https://github.com/JOYCEQL/magic-resume
|
||||
|
||||
## 🌟 支持项目
|
||||
|
||||
如果这个项目对你有帮助，欢迎点个 star ⭐️
|
||||
Reference in New Issue
Block a user