# ResumeGen

**Repository Path**: stroked/resume-gen

## Basic Information

- **Project Name**: ResumeGen
- **Description**: ResumeGen：一个专注于自动生成简历的开源项目，支持多种模板和格式，旨在帮助用户快速创建专业美观的简历。
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-29
- **Last Updated**: 2025-12-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 简历生成器

基于 Vue3 + TypeScript + Vite 构建的在线简历编辑和导出工具，支持实时编辑、预览和PDF导出功能。

## 功能特性

- ✨ **实时编辑** - 所见即所得的简历编辑体验
- 📱 **响应式设计** - 适配各种设备屏幕
- 📄 **PDF导出** - 一键导出高质量PDF简历
- 🎨 **组件化架构** - 使用Element Plus组件库
- 🔧 **状态管理** - 使用Pinia进行状态管理
- 🌐 **国际化** - 支持中英文界面

## 技术栈

- **前端框架**: Vue 3 (Composition API)
- **语言**: TypeScript
- **构建工具**: Vite
- **UI组件库**: Element Plus
- **状态管理**: Pinia
- **路由管理**: Vue Router
- **PDF导出**: jsPDF + html2canvas
- **样式**: SCSS

## 快速开始

### 环境要求

- Node.js >= 14.0.0
- npm 或 yarn

### 安装与运行

```bash
# 克隆项目
git clone <repository-url>

# 进入项目目录
cd resume-gen

# 安装依赖
npm install

# 启动开发服务器
npm run dev

# 构建生产版本
npm run build

# 预览生产构建
npm run preview
```

### 项目结构

```
resume-gen/
├── src/
│   ├── components/     # 可复用组件
│   ├── views/          # 页面视图
│   ├── stores/         # Pinia状态管理
│   ├── router/         # 路由配置
│   ├── styles/         # 样式文件
│   ├── utils/          # 工具函数
│   ├── assets/         # 静态资源
│   └── App.vue         # 根组件
├── public/             # 静态资源
├── index.html          # HTML模板
├── vite.config.ts      # Vite配置
├── tsconfig.json       # TypeScript配置
└── package.json        # 项目依赖
```

## 功能模块

### 1. 简历编辑器
- 基本信息编辑（姓名、联系方式等）
- 工作经历管理
- 教育经历管理
- 技能专长管理
- 项目经验管理

### 2. 实时预览
- 实时显示编辑效果
- 响应式简历模板

### 3. PDF导出
- 一键导出PDF格式简历
- 高质量打印效果

## 使用说明

1. 访问首页，点击"开始制作简历"
2. 在编辑器页面填写个人信息
3. 实时查看预览效果
4. 点击"预览简历"查看完整效果
5. 点击"导出PDF"保存简历

## 自定义配置

### 主题颜色
修改 `src/styles/element/index.scss` 文件来自定义Element Plus主题颜色。

### 响应式断点
在 `src/styles/responsive.scss` 中定义响应式断点和样式。

## 部署

### 静态部署
构建后的文件在 `dist/` 目录中，可部署到任何静态文件服务器。

### 常用部署平台
- GitHub Pages
- Netlify
- Vercel
- 阿里云OSS
- 腾讯云COS

## 开发规范

### 代码风格
- 使用 ESLint 进行代码检查
- 使用 Prettier 进行代码格式化
- 遵循 TypeScript 最佳实践

### 组件命名
- 使用 PascalCase 命名组件文件
- 使用 kebab-case 命名路由组件

## 贡献指南

1. Fork 项目
2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 开启 Pull Request

## 许可证

本项目采用 MIT 许可证 - 详见 [LICENSE](./LICENSE) 文件。

## 联系方式

如有问题或建议，请提交 Issue 或联系项目维护者。