|
1 | 1 | # PeerChat |
2 | 2 |
|
| 3 | +A real-time peer-to-peer chat application built with WebRTC technology. Enables direct communication between users without requiring a central server, featuring a clean interface and smooth chat experience. |
3 | 4 |
|
| 5 | +## Features |
4 | 6 |
|
5 | | -PeerChat是一个基于WebRTC技术的实时点对点聊天应用,无需中心服务器即可实现用户之间的直接通信。提供了简洁直观的用户界面和流畅的聊天体验。 |
| 7 | +### Decentralized Communication |
6 | 8 |
|
7 | | -## 功能特点 |
| 9 | +- Direct P2P communication via WebRTC |
8 | 10 |
|
9 | | -### 去中心化通信 |
| 11 | +- No central server for message storage, protecting user privacy |
10 | 12 |
|
11 | | -- 基于WebRTC的P2P直接通信 |
| 13 | +- NAT traversal support for various network environments |
12 | 14 |
|
13 | | -- 无需中央服务器存储消息,保护用户隐私 |
| 15 | +### Group Chat |
14 | 16 |
|
15 | | -- 支持NAT穿透,适用于各种网络环境 |
| 17 | +- Create and join group chats |
16 | 18 |
|
17 | | -### 群聊功能 |
| 19 | +- Host/member role distinction |
18 | 20 |
|
19 | | -- 支持创建和加入群聊 |
| 21 | +- Real-time online member display |
20 | 22 |
|
21 | | -- 主持人/成员角色区分 |
| 23 | +### User-Friendly Interface |
22 | 24 |
|
23 | | -- 实时显示在线成员 |
| 25 | +- Intuitive chat interface with message type differentiation |
24 | 26 |
|
25 | | -### 用户友好界面 |
| 27 | +- Special indicators for host messages |
26 | 28 |
|
27 | | -- 直观的聊天界面,区分不同类型消息 |
| 29 | +- Message status display (sending, sent, etc.) |
28 | 30 |
|
29 | | -- 主持人消息特殊标识 |
| 31 | +### Instant Sharing |
30 | 32 |
|
31 | | -- 消息状态显示(发送中、已发送等) |
| 33 | +- Generate shareable group chat links |
32 | 34 |
|
33 | | -### 即时分享 |
| 35 | +- Quick join via links or IDs |
34 | 36 |
|
35 | | -- 生成可分享的群聊链接 |
36 | | - |
37 | | -- 通过链接或ID快速加入群聊 |
38 | | - |
39 | | -## 技术栈 |
| 37 | +## Tech Stack |
40 | 38 |
|
41 | 39 | - React + TypeScript + Vite + PeerJS |
42 | 40 |
|
43 | | -## 本地开发 |
| 41 | +## Local Development |
44 | 42 |
|
45 | 43 | ```bash |
46 | | -# 安装依赖 |
| 44 | +# Install dependencies |
47 | 45 | npm install |
48 | 46 |
|
49 | | -# 启动开发服务器 |
| 47 | +# Start development server |
50 | 48 | npm run dev |
51 | 49 |
|
52 | | -# 构建生产版本 |
| 50 | +# Build for production |
53 | 51 | npm run build |
54 | 52 |
|
55 | | -# 预览生产构建 |
| 53 | +# Preview production build |
56 | 54 | npm run preview |
57 | 55 |
|
58 | | -# 部署到 GitHub Pages |
| 56 | +# Deploy to GitHub Pages |
59 | 57 | npm run deploy |
60 | 58 | ``` |
61 | 59 |
|
62 | | -## 在线演示 |
| 60 | +## Live Demo |
63 | 61 |
|
64 | | -访问 [https://sumingcheng.github.io/PeerChat/](https://sumingcheng.github.io/PeerChat/) 查看在线演示。 |
| 62 | +Visit [https://sumingcheng.github.io/PeerChat/](https://sumingcheng.github.io/PeerChat/) for live demo. |
65 | 63 |  |
66 | 64 |  |
67 | 65 |  |
68 | 66 |  |
69 | 67 |
|
70 | | -## 许可证 |
| 68 | +## License |
71 | 69 |
|
72 | 70 | Apache License Version 2.0 |
73 | 71 |
|
74 | | -## 基本概念图示 |
| 72 | +## Architecture Overview |
75 | 73 |  |
76 | 74 |
|
77 | | -## 捐赠 |
| 75 | +## Donation |
0 commit comments