chat-pc/README.md

105 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

# IM - 在线即时通讯应用
2024-12-24 08:14:21 +00:00
IM 是一个基于 Vue 3 开发的现代化在线即时通讯应用,提供实时聊天、消息管理、笔记等功能。
2024-12-24 08:14:21 +00:00
## 功能特性
2024-12-24 08:14:21 +00:00
- 📱 实时聊天:支持一对一即时通讯
- 📝 消息管理:高效管理各类消息
- 📓 笔记功能支持Markdown格式的笔记编辑与管理
- 🌓 暗色模式:支持明暗主题切换,呵护您的眼睛
- 🔒 用户认证:完善的登录注册系统
2024-12-24 08:14:21 +00:00
## 技术栈
2024-12-24 08:14:21 +00:00
- **前端框架**Vue 3 + TypeScript
- **状态管理**Pinia
- **UI组件库**Naive UI
- **路由管理**Vue Router
- **CSS预处理器**Less
- **构建工具**Vite
- **WebSocket**:用于实时通讯
- **编辑器**
- Markdown编辑器@kangc/v-md-editor
- 富文本编辑器Quill
2024-12-24 08:14:21 +00:00
## 快速开始
2024-12-24 08:14:21 +00:00
### 环境要求
2024-12-24 08:14:21 +00:00
- Node.js >= 14.0.0
- pnpm >= 6.0.0
2024-12-24 08:14:21 +00:00
### 安装依赖
2024-12-24 08:14:21 +00:00
```bash
pnpm install
```
2024-12-24 08:14:21 +00:00
### 开发环境运行
2024-12-24 08:14:21 +00:00
```bash
# 测试环境
pnpm dev:test
2024-12-24 08:14:21 +00:00
# 生产环境
pnpm dev:prod
2024-12-24 08:14:21 +00:00
```
### 打包构建
2024-12-24 08:14:21 +00:00
```bash
# 测试环境构建
pnpm build:test
# 生产环境构建
pnpm build:prod
2024-12-24 08:14:21 +00:00
```
### 预览构建后的项目
2024-12-24 08:14:21 +00:00
```bash
pnpm preview
```
2024-12-24 08:14:21 +00:00
## 项目结构
2024-12-24 08:14:21 +00:00
```
src/
├── api/ # API请求
├── assets/ # 静态资源
├── components/ # 公共组件
├── connect.ts # WebSocket连接管理
├── constant/ # 常量定义
├── directive/ # 自定义指令
├── event/ # 事件管理
├── hooks/ # 自定义钩子
├── layout/ # 布局组件
├── main.ts # 入口文件
├── plugins/ # 插件配置
├── router/ # 路由配置
├── store/ # 状态管理
├── types/ # 类型定义
├── utils/ # 工具函数
└── views/ # 页面视图
```
2024-12-24 08:14:21 +00:00
## 环境变量配置
2024-12-24 08:14:21 +00:00
项目支持不同环境配置,环境变量文件位于`env/`目录下。
## 浏览器支持
2024-12-24 08:14:21 +00:00
支持现代浏览器如Chrome、Firefox、Safari、Edge等。
2024-12-24 08:14:21 +00:00
## 相关链接
2024-12-24 08:14:21 +00:00
- [Vue 3](https://v3.vuejs.org/)
- [Vite](https://vitejs.dev/)
- [Naive UI](https://www.naiveui.com/)
- [Pinia](https://pinia.vuejs.org/)
2024-12-24 08:14:21 +00:00
## 许可证
2024-12-24 08:14:21 +00:00
Copyright © 2023 IM