# im

**Repository Path**: andy1215/im

## Basic Information

- **Project Name**: im
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-27
- **Last Updated**: 2026-01-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# IM 即时通讯项目

一个完整的即时通讯解决方案，包含管理后台、服务端、桌面客户端和移动端应用。

## 项目简介

本项目是一个功能完善的即时通讯系统，采用前后端分离架构，提供多端统一的通讯体验。系统由以下几个核心模块组成：

- **im_admin** - 管理后台前端 (Vue 3 + TypeScript)
- **im_admin_server** - 管理后台服务端 (Hyperf PHP Framework)
- **im_electron** - 桌面客户端 (Electron + Vue 3)
- **im_server** - 通讯服务核心 (Node.js)
- **im_uniapp** - 移动端应用 (uni-app + Vue 3)

## 技术栈

### 前端
- **Vue 3** - 渐进式 JavaScript 框架
- **TypeScript** - 类型安全的 JavaScript 超集
- **Vite** - 现代前端构建工具
- **Pinia** - Vue 状态管理库
- **Vue Router** - Vue.js 官方路由管理器

### 后端
- **Hyperf** - 高性能 PHP 协程框架
- **MySQL** - 关系型数据库
- **Redis** - 缓存与消息队列

### 跨平台
- **Electron** - 跨平台桌面应用开发
- **uni-app** - 跨平台移动应用开发框架

## 项目结构

```
im/
├── im_admin/              # 管理后台前端
│   ├── src/
│   │   ├── components/    # Vue 组件
│   │   ├── views/         # 页面视图
│   │   ├── router/        # 路由配置
│   │   ├── stores/        # 状态管理
│   │   └── assets/        # 静态资源
│   └── ...
│
├── im_admin_server/       # 管理后台服务端
│   ├── app/
│   │   ├── Controller/    # 控制器
│   │   ├── Model/         # 数据模型
│   │   ├── Listener/      # 事件监听器
│   │   └── Exception/     # 异常处理
│   ├── config/            # 配置文件
│   └── test/              # 测试用例
│
├── im_electron/           # 桌面客户端
│   ├── src/
│   │   ├── main.ts        # 主进程
│   │   ├── preload.ts     # 预加载脚本
│   │   └── renderer.ts    # 渲染进程
│   └── ...
│
├── im_uniapp/             # 移动端应用
│   ├── src/
│   │   ├── pages/         # 页面
│   │   ├── components/    # 组件
│   │   └── static/        # 静态资源
│   └── ...
│
└── im_server/             # 通讯服务核心
    └── package.json
```

## 快速开始

### 环境要求

- Node.js >= 16.0
- PHP >= 8.0
- MySQL >= 5.7
- Redis >= 6.0
- Composer

### 安装依赖

**管理后台前端**
```bash
cd im_admin
npm install
```

**管理后台服务端**
```bash
cd im_admin_server
composer install
```

**桌面客户端**
```bash
cd im_electron
npm install
```

**移动端应用**
```bash
cd im_uniapp
npm install
```

### 启动服务

**开发模式启动**

管理后台前端：
```bash
cd im_admin
npm run dev
```

管理后台服务端：
```bash
cd im_admin_server
php bin/hyperf.php start
```

桌面客户端：
```bash
cd im_electron
npm run dev
```

**生产环境构建**

管理后台前端：
```bash
cd im_admin
npm run build
```

桌面客户端：
```bash
cd im_electron
npm run build
```

## 功能特性

- 即时消息发送与接收
- 用户管理与认证
- 群组聊天
- 消息历史记录
- 文件传输
- 跨平台支持（Web、桌面、移动端）

## 配置说明

各模块的配置文件位于：

- `im_admin/.env` - 前端环境变量
- `im_admin_server/.env` - 服务端环境变量
- `im_admin_server/config/` - 服务端配置目录

## 开发指南

### 代码规范

- 前端代码使用 ESLint + Prettier 进行格式化
- 后端代码遵循 PSR 标准规范
- 提交代码前请运行 lint 检查

### 常用命令

```bash
# 前端类型检查
cd im_admin
npm run type-check

# 运行测试
cd im_admin_server
./vendor/bin/phpunit

# 代码检查
cd im_admin
npm run lint
```

## 许可证

本项目遵循开源许可证，具体信息请查看各模块 LICENSE 文件。

## 贡献指南

欢迎提交 Issue 和 Pull Request 来帮助改进项目。

## 联系方式

项目地址：https://gitee.com/andy1215/im