# el-client

**Repository Path**: AndyWang66/el-client

## Basic Information

- **Project Name**: el-client
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-09
- **Last Updated**: 2026-09-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# el-client（学习鹿仙 CRM 客户端）

前后端分离的一体化 CRM 系统客户端仓库：

- **el-app**：基于 Electron + Vue 3 的桌面客户端（Windows / macOS / Linux）
- **el-server**：基于 Spring Boot 的 Java 后端服务（多模块 Maven 工程，含系统管理与 CRM 业务）

## 项目结构

```
el-client/
├── el-app/                # 桌面客户端（前端）
│   ├── src/main/          # Electron 主进程（窗口框架、路由、自动更新）
│   ├── src/preload/       # 预加载脚本
│   ├── src/renderer/      # 渲染进程（Vue 应用：api/views/store/router...）
│   ├── build/             # 打包图标资源
│   └── electron-builder.yml
└── el-server/             # 后端服务
    ├── open-deer-admin/         # 启动入口（配置文件、多环境 profile）
    ├── open-deer-dependencies/  # 依赖版本统一管理（BOM）
    ├── open-deer-common/        # 通用工具与常量
    ├── open-deer-framework/     # 框架核心（安全认证、切面、拦截等）
    ├── open-deer-system/        # 系统管理模块（用户/角色/菜单/字典等）
    ├── open-deer-quartz/        # 定时任务模块
    ├── xiaoluxian-crm/          # CRM 核心业务
    ├── xiaoluxian-crm-media/    # 新媒体业务
    ├── xiaoluxian-crm-obtain/   # 就业中心
    ├── xiaoluxian-crm-recruit/  # 招生中心
    ├── xiaoluxian-crm-teach/    # 教学中心
    ├── xiaoluxian-crm-websocket/ # WebSocket 实时通信
    └── sql/                     # 数据库脚本
```

## 前端技术栈（el-app）

| 类别 | 技术 | 版本 |
| --- | --- | --- |
| 桌面框架 | Electron | 25.x |
| 前端框架 | Vue 3（Composition API） | 3.3.x |
| 开发语言 | TypeScript | 5.1.x |
| 构建工具 | electron-vite（基于 Vite 4） | 1.0.x |
| UI 组件库 | Element Plus + Icons | 2.4.x |
| 状态管理 | Pinia + pinia-plugin-persist（持久化） | 2.1.x |
| 路由 | Vue Router | 4.2.x |
| 国际化 | vue-i18n | 9.8.x |
| 图表 | ECharts | 5.5.x |
| 富文本编辑器 | wangEditor 5（含 Vue 适配） | 5.1.x |
| 网络请求 | axios | 1.6.x |
| 对象存储 | ali-oss（阿里云 OSS 直传） | 6.20.x |
| 加密 | crypto-js | 4.2.x |
| 日志 | electron-log | 5.1.x |
| 自动更新 | electron-updater | 6.1.x |
| 自动导入 | unplugin-auto-import / unplugin-vue-components | - |
| 代码规范 | ESLint + Prettier | - |
| 样式 | Less + Sass | - |

### 前端常用命令

```bash
cd el-app
npm install          # 安装依赖（自动执行 electron-builder install-app-deps）
npm run dev          # 本地开发
npm run build        # 构建产物
npm run build:win    # 打包 Windows 安装包（NSIS）
npm run build:mac    # 打包 macOS 安装包（DMG）
npm run build:linux  # 打包 Linux（AppImage / snap / deb）
npm run typecheck    # 主进程 + 渲染进程类型检查
npm run lint         # ESLint 检查并修复
```

## 后端技术栈（el-server）

| 类别 | 技术 | 版本 |
| --- | --- | --- |
| 基础框架 | Spring Boot | 2.7.2 |
| JDK | Java | 1.8 |
| 认证授权 | Spring Security + JWT（jjwt） | 5.7.x / 0.9.1 |
| ORM | MyBatis-Plus（全局逻辑删除 del_flag） | 3.5.1 |
| 分页 | PageHelper | 1.4.3 |
| 消息队列 | RocketMQ（rocketmq-spring-boot-starter） | 2.2.3 |
| 定时任务 | Quartz | - |
| 工具库 | Hutool、FastJSON 2、Lombok、Commons-IO | - |
| Excel 导入导出 | EasyExcel | 3.1.1 |
| 系统监控 | OSHI（硬件/系统信息）、mica-ip2region（IP 归属地） | - |
| 短信 | 腾讯云 SMS SDK | 3.1.x |
| 对象存储 | 阿里云 OSS SDK | 3.10.2 |
| 第三方登录 | JustAuth、WxJava（微信公众号） | - |
| 邮件 | javax.mail | 1.6.2 |

### 后端模块与多环境

- 启动入口：`open-deer-admin`（应用名 `open-deer-instance`）
- 多环境配置：`application-dev.yml` / `application-uat.yml` / `application-prd.yml`（默认激活 `prd`）
- 依赖版本统一在 `open-deer-dependencies`（BOM）中管理

### 后端构建运行

```bash
cd el-server
mvn clean install -DskipTests        # 编译打包
# 运行 open-deer-admin 下的启动类，或：
mvn spring-boot:run -pl open-deer-admin
```

## 环境要求

| 组件 | 版本 |
| --- | --- |
| Node.js | ≥ 16（建议 18） |
| JDK | 1.8 |
| Maven | 3.6+ |
| MySQL | 5.7+ / 8.0（执行 `el-server/sql` 初始化脚本） |
| Redis / RocketMQ | 按后端 `application-*.yml` 配置 |

## 相关说明

- 自动更新发布地址在 `el-app/electron-builder.yml` 的 `publish.url` 中配置
- 前后端接口地址等本地配置通过 `.env` / `application-*.yml` 管理，均已加入 `.gitignore` 或按需提交