助力高校计算机教育 —— 码云为老师推出免费高校版,高达 200 人的协作团队
Watch Star Fork

easysoft / xuanxuanNodeJS

加入码云
与超过 200 万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
喧喧是一个轻量级的企业聊天软件。由然之协同办公团队开发。 http://xuan.im
一键复制 编辑 原始数据 按行查看 历史
README_en.md 5.47 KB Catouse 提交于 2018-03-08 10:50 . * update document files.

Xuanxuan

http://xuan.im

proudly presented by Zdoo and an IM solution for enterprises.

Know more about the development plans of Xuanxuan:http://xuan.5upm.com/product-browse-1.html

Xuanxuan

Latest Update

🎉 Version 1.3 has added the long-anticipated extension mechanisms which provide more flexible ways to integrate your business with Xuanxuan. It also added several practical features, such as search chat history, dismiss chat group, check contacts by departments or roles, and change password.

🎉 Dark theme has been built in the extension mechanism. It is a brand new experience and let's try it!

Xuanxuan

Features

  • Chat:Chat with any user on your server. Emojis, images, screenshots and files are all supported.
  • Open Source:Source code is open. Communications of both the client and the server are encrypted and secured.
  • Chat Group:Invite more users to join your group chat. Set it as public, so any user could join in.
  • Notification:Integrated with your desktop and get notified of new messages.
  • Chat Management:Set sticky chat, including group chat and publich group chat and never miss any great chat. Rename the chat group and set a whitelist and the privilege to view the chat history.
  • Contact List:Profile and contact information of all users within an enterprise.
  • Cross-Platform Client:Windows, Linux and Mac are supported,and a browser client is provided.
  • Lightweight Server:Very convenient to integrate with Zdoo.

Use

Desktop Client

Thanks to the cross-platform feature of Electron, Xuanxuan have Windows, MacOS and Linux versions.

Download:http://xuan.im/#downloads

Check Xuanxuan Official User Guide for more help.

Browser Client

Visit:https://easysoft.github.io/xuanxuan/1.4.0/ for Xuanxuan browser cient.

Note:You have to deploy a Xuanxuan official authenticated certificate to use brower clients.

For more help, please visit Xuanxuan Browser Client Deployment and User Guide

Server Client

Instant communication of Xuanxuan client with the server is done via WebSocket. Besides, https is used to get config, upload, and dowload files from the server.

+------------+                 +------------+            +----------------+
|  Xuanxuan  |---------------->|  Xuanxuan  |----------->|   Rangerteam   |
|   Client   | WebSocket/Https |   Server   | Http/Https |     Server     |
|  (PC/Mac)  |<----------------|   (xxd)    |<-----------| (Your Website) |
+------------+                 +------------+            +----------------+

API Reference of client and server:API Doc. API of the server is open too, and you can use technologies that you are familiar with, such as node.js, go, and swift, to implement your server.

Xuanxuan default server use go to develop(AKA xxd ), and you can find the source code in /server/xxd/ . xxd provides interfacee of WebSocket and https for clients.

xxd does not save or manage any user information or data, but uses http, a broader protocol, and another server(AKA http)to communicate. Therefore, all you hav to do is to develop interfaces of http on your site and your site users can use Xuanxuan.

http provided by Xuanxuan is based on an open source collaborative tool Zdoo and you can find its source code in /server/ranzhi/. For Zdoo server deployment, please refer to:Zdoo Server Deployment Guide

Here is a demo on a public test server:

Adrdress:https://demo.ranzhi.org
User:demo
Password:demo

or User:demo1, demo2, ... demo10
Password:123456

Note:On a test server, it is not supported to transfer files.

Client Customization

Main technologies used in Xuanxuan are Webpack + Electron + React. Follow the steps below and expidite your customization:

  1. Download the source code:git clone https://github.com/easysoft/xuanxuan.git
  2. Run:npm install
  3. Start react hot server, and run:npm run hot-server
  4. Start Xuanuan client and run:npm run start-hot

Run npm run package to package the client.

For more details, refer to:Client Customization Guide For Developers

Customization

Refer to:https://github.com/easysoft/xuanxuan/blob/master/doc/extension.md

License

Xuanxuan is under ZPL and uses open source projects as follows,

评论 ( 0 )

你可以在登录后,发表评论

10_float_left_people 10_float_left_close