# XLChat
**Repository Path**: belovedLYC/xlchat
## Basic Information
- **Project Name**: XLChat
- **Description**: 基于Electron的实时通讯
- **Primary Language**: TypeScript
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-09-13
- **Last Updated**: 2025-09-17
## Categories & Tags
**Categories**: im
**Tags**: None
## README
# XLChat 💬
一个基于 **Electron** 和 **Vue 3** 构建的现代化桌面即时通讯应用，提供流畅的聊天体验和丰富的功能特性。
## ✨ 功能特性
- 🔐 **用户认证系统** - 支持用户名/邮箱登录
- 💬 **实时聊天** - 即时消息发送与接收
- 👥 **联系人管理** - 好友列表和状态管理
- 🎨 **现代化UI** - 响应式设计和主题支持
- 📱 **跨平台支持** - Windows、macOS、Linux
- 🛠️ **开发者工具** - 内置调试工具和快捷键
- 📎 **文件传输** - 支持文件发送和接收
- 🎭 **表情支持** - 丰富的表情符号
## 🛠️ 技术栈
### 🎨 前端框架
> **Vue 3** - 渐进式JavaScript框架
>
> **TypeScript** - 类型安全的JavaScript超集
>
> **Vite** - 下一代前端构建工具
### 🖥️ 桌面应用
> **Electron** - 跨平台桌面应用框架
>
> **Electron Builder** - 应用打包和分发工具
>
> **Electron Vite** - 快速开发工具链
### 🗃️ 状态管理
> **Pinia** - Vue 3 官方状态管理库
>
> **Vue Router** - 官方路由管理器
### 🎭 UI组件与工具
> **Lucide Vue Next** - 现代化图标库
>
> **VueUse** - Vue 组合式API工具集
### 🔧 开发工具
> **ESLint** - 代码质量检查
>
> **Prettier** - 代码格式化
>
> **Vue TSC** - TypeScript类型检查
## 📦 项目结构
```
XLChat/
├── src/
│ ├── main/ # Electron主进程
│ ├── preload/ # 预加载脚本
│ └── renderer/ # Vue渲染进程
│ ├── components/ # Vue组件
│ ├── store/ # Pinia状态管理
│ ├── composables/# 组合式API
│ └── assets/ # 静态资源
├── resources/ # 应用资源
└── 配置文件...
```
## 🚀 快速开始
### 环境要求
- Node.js >= 16.0.0
- npm >= 8.0.0
### 安装依赖
```bash
npm install
```
### 开发模式
```bash
npm run dev
```
### 类型检查
```bash
npm run typecheck
```
### 代码格式化
```bash
npm run format
```
### 代码检查
```bash
npm run lint
```
## 📦 构建应用
### 开发构建
```bash
npm run build
```
### 平台特定构建
```bash
# Windows
npm run build:win
# macOS
npm run build:mac
# Linux
npm run build:linux
```
### 仅构建不打包
```bash
npm run build:unpack
```
## 🎯 开发指南
### 推荐IDE配置
- [VSCode](https://code.visualstudio.com/)
- [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)
### 项目配置
项目使用 TypeScript 进行类型检查，支持：
- 主进程类型检查：`npm run typecheck:node`
- 渲染进程类型检查：`npm run typecheck:web`
- 全项目类型检查：`npm run typecheck`
## 📄 许可证
MIT License
## 👨💻 作者
**LYC** - 项目创建者和维护者
---
> 💡 **提示**: 这是一个正在开发中的项目，欢迎提交 Issue 和 Pull Request！