Skip to content

Commit 079e219

Browse files
committed
update readme
1 parent dd63cc8 commit 079e219

File tree

1 file changed

+8
-100
lines changed

1 file changed

+8
-100
lines changed

README.MD

Lines changed: 8 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,10 @@
1-
## 野火IM解决方案
1+
## 野火IM Web端说明
22

3-
野火IM是一套跨平台开源的即时通讯解决方案,主要包含以下内容。
3+
目前,野火IM Web有两个版本
44

5-
| 仓库 | 说明 | 备注 |
6-
| ------------------------------------------------------------ | ------------------------------------------------------- | ---- |
7-
| [android-chat](https://github.com/wildfirechat/android-chat) | 野火IM Android SDK源码和App源码 |可以很方便地进行二次开发,或集成到现有应用当中 |
8-
| [ios-chat](https://github.com/wildfirechat/ios-chat) | 野火IM iOS SDK源码和App源码 |可以很方便地进行二次开发,或集成到现有应用当中 |
9-
| [pc-chat](https://github.com/wildfirechat/pc-chat) | 基于[Electron](https://electronjs.org/)开发的PC平台应用 | |
10-
| [web-chat](https://github.com/wildfirechat/web-chat) | Web平台的Demo, [体验地址](http://web.wildfirechat.cn) | |
11-
| [wx-chat](https://github.com/wildfirechat/wx-chat) | 微信小程序平台的Demo | |
12-
| [server](https://github.com/wildfirechat/server) | IM server | |
13-
| [app server](https://github.com/wildfirechat/app_server) | 应用服务端 | |
14-
| [robot_server](https://github.com/wildfirechat/robot_server) | 机器人服务端 | |
15-
| [push_server](https://github.com/wildfirechat/push_server) | 推送服务器 | |
16-
| [docs](https://github.com/wildfirechat/docs) | 野火IM相关文档,包含设计、概念、开发、使用说明 | | |
17-
18-
## web-chat说明
19-
20-
本工程是野火IM Web平台Demo,详情可以阅读[docs](http://docs.wildfirechat.cn).
21-
22-
开发一套IM系统真的很艰辛,请路过的朋友们给点个star,支持我们坚持下去🙏🙏🙏🙏🙏
23-
24-
### 重要提示
25-
1. 本项目采用的是[react](https://reactjs.org/) 技术栈,使用[vue](https://vuejs.org/) 的小伙伴请参考[vue-chat](https://github.com/wildfirechat/vue-chat)
26-
2. ```react```版本现处于维护模式,仅修复bug;后续我们的开发重心是```vue```版本,建议大家使用```vue```版本。
27-
28-
### 联系我们
29-
30-
> 商务合作请优先采用邮箱和我们联系。技术问题请到[野火IM论坛](http://bbs.wildfirechat.cn/) 发帖交流。
31-
32-
1. heavyrain.lee 邮箱: [email protected] 微信:wildfirechat
33-
2. imndx 邮箱: [email protected] 微信:wfchat
34-
35-
36-
### 问题交流
37-
38-
1. 如果大家发现bug,请在GitHub提issue
39-
2. 其他问题,请到[野火IM论坛](http://bbs.wildfirechat.cn/)进行交流学习
40-
3. 微信公众号
41-
42-
<img src="http://static.wildfirechat.cn/wx_wfc_qrcode.jpg" width = 50% height = 50% />
43-
44-
45-
## 体验
46-
47-
[在线体验野火IM Web版](http://web.wildfirechat.cn),请使用野火IM Andorid或iOS Demo扫码登录
48-
49-
50-
## 截图
51-
52-
![home](./screenshots/home.png)
53-
54-
55-
![chat](./screenshots/chat.png)
56-
57-
58-
59-
![create_conversation](./screenshots/create_conversation.png)
60-
61-
## 开发、打包依赖
62-
1. nodejs v10.16.3
63-
2. npm 6.9.0
64-
65-
## 开发
66-
```
67-
$ npm install
68-
$ npm run dev
69-
浏览器访问: http://localhost:5000
70-
71-
```
72-
73-
## 打包
74-
75-
```
76-
$ npm install
77-
$ npm run build
78-
```
79-
80-
## 服务器部署
81-
0. 修改```config/index.js```文件里面的```STATIC_RESOURCE_PATH```,让其指向打算部署```web-chat```的服务器
82-
1. ``` npm run release```
83-
2. 将dist目录传到服务器
84-
3. 配置nginx,可参考[nginx参考配置](nginx/web.conf)
85-
86-
87-
## 音视频通话
88-
0. 可修改```config.js```文件下的```ENABLE_MULTI_VOIP_CALL```,打开多人音视频支持,该功能目前正在开发中,遇到问题,请向我们反馈
89-
90-
更多信息,请查看[wewechat readme](./README_wewechat.MD)
91-
92-
93-
## License
94-
95-
1. Under the Creative Commons Attribution-NoDerivs 3.0 Unported license. See the [LICENSE](https://github.com/wildfirechat/web-chat/blob/master/LICENSE) file for details.
96-
2. Under the 996ICU License. See the [LICENSE](https://github.com/996icu/996.ICU/blob/master/LICENSE) file for details.
97-
98-
99-
100-
# 鸣谢
101-
102-
本项目基于[wewechat](https://github.com/trazyn/weweChat)开发,原项目的READ见[wewechat readme](./README_wewechat.MD)
5+
1. [vue-chat](https://github.com/wildfirechat/vue-chat),
6+
基于```vue```技术栈开发,是未来开发的重心。
7+
2. [react-chat](https://github.com/wildfirechat/react-chat),
8+
基于```react```技术栈开发,功能完善,目前处于***维护阶段***,只修复严重bug,不开发新功能。
9+
10+
**建议大家选择```vue```版本进行二次开发!**

0 commit comments

Comments
 (0)