# w-im

**Repository Path**: AF01C8BDA51B/w-im

## Basic Information

- **Project Name**: w-im
- **Description**: 一个类微信桌面端软件,全程由cursor编写,不会人工参与修改
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-01-25
- **Last Updated**: 2025-02-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# W-IM
# W-IM 即时通讯应用

一个基于 Electron + Vue3 开发的现代化即时通讯应用。
# 这是一个使用 Electron 和 Vue3 构建的桌面端即时通讯软件

## 功能特性
# 主要功能列表

- 🔐 安全的用户认证系统  # 提供安全可靠的用户登录和认证功能
- 💬 实时消息通讯        # 支持实时的文字消息收发
- 👥 通讯录管理          # 提供联系人管理功能
- ⭐ 消息收藏            # 支持重要消息的收藏功能
- 📁 文件传输            # 支持文件的发送和接收
- ⚙️ 个性化设置          # 提供个性化的软件设置选项
- 🎨 现代化 UI 设计      # 采用现代简约的界面设计
- 🌙 主题定制            # 支持主题颜色的自定义

## 技术栈
# 项目使用的主要技术框架

- Electron 31.0.2       # 跨平台桌面应用开发框架
- Vue 3                 # 前端开发框架
- Vue Router            # 页面路由管理
- Element Plus         # UI 组件库
- Remixicon            # 图标库
- Electron Vite        # 构建工具

## 开发环境
# 开发环境配置说明

### 推荐的 IDE 配置
# 推荐使用的开发工具和插件

- [VSCode](https://code.visualstudio.com/) + 以下插件:  # Visual Studio Code 编辑器
  - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)          # 代码质量检查工具
  - [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)        # 代码格式化工具
  - [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)                        # Vue 3 开发工具

### 系统要求
# 运行项目需要的环境要求

- Node.js 16+           # Node.js 运行环境，版本需要 16 或更高
- npm 7+                # npm 包管理器，版本需要 7 或更高

## 快速开始
# 项目启动指南

### 安装依赖
# 安装项目所需的依赖包

```bash
# 安装项目依赖
npm install             # 安装主项目的依赖包

# 安装 preload 依赖
cd preload             # 进入 preload 目录
npm install            # 安装 preload 的依赖包
cd ..                  # 返回主目录
```

### 开发模式
# 启动开发环境

```bash
# 启动开发服务器
npm run dev            # 启动开发模式的应用
```

### 打包构建
# 构建生产环境应用

```bash
# Windows
npm run build:win      # 构建 Windows 版本

# macOS
npm run build:mac      # 构建 macOS 版本

# Linux
npm run build:linux    # 构建 Linux 版本
```

## 项目结构
# 项目目录结构说明

```
w-im/
├── src/               # 源代码目录
│   ├── main/         # Electron 主进程代码
│   ├── preload/      # 预加载脚本代码
│   └── renderer/     # Vue 渲染进程代码
├── resources/        # 资源文件目录
├── preload/         # 预加载脚本构建目录
└── release/         # 打包输出目录
```

## 开发指南
# 开发相关说明

### 主题定制
# 主题配置说明

项目使用 CSS 变量进行主题定制，配置文件位于：
- `src/renderer/src/styles/theme.css`    # CSS 变量定义文件
- `src/renderer/src/styles/theme.js`     # JavaScript 主题配置文件

### IPC 通信
# 进程间通信配置

主进程和渲染进程之间的通信通过 IPC 实现，相关配置位于：
- `src/main/handlers/ipc.js`    # 主进程 IPC 处理器
- `preload/index.js`            # 预加载脚本 IPC 配置

## 测试账号
# 用于测试的账号信息

- 用户名: admin               # 测试用户名
- 密码: 123456               # 测试密码

## 贡献指南
# 如何参与项目开发

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)    # 使用 MIT 开源许可证

## 联系方式
# 项目相关联系方式

- 项目主页：[GitHub](https://github.com/yourusername/w-im)     # 项目 GitHub 地址
- 问题反馈：[Issues](https://github.com/yourusername/w-im/issues)  # 问题反馈页面