Project Icon

Rocket.Chat.Electron

基于Electron的Rocket.Chat跨平台桌面应用

Rocket.Chat.Electron是基于Electron框架的跨平台桌面应用,支持macOS、Windows和Linux。提供静默安装、多用户安装、自动更新等功能,允许配置默认服务器和单服务器模式。项目采用TypeScript重写,使用Jest测试,支持tray图标、闪烁通知等功能,并可通过JSON文件自定义设置。用户可轻松体验Rocket.Chat通讯服务,享受丰富的开发和定制选项。

Rocket.Chat 桌面应用

Travis CI 构建状态 AppVeyor 构建状态 Codacy 徽章 项目依赖 GitHub 所有版本 GitHub

基于Electron开发的Rocket.Chat桌面应用,支持macOS、Windows和Linux系统。

Rocket.Chat 桌面应用


与我们互动

分享您的故事

我们很乐意听到[您的体验][],并可能在我们的[博客][]上展示。

订阅更新

我们的营销团队每月会发布一次电子邮件更新,包含产品发布、公司相关话题、活动和使用案例的新闻。[立即注册!][]


下载

您可以从[发布页面][]下载最新版本。

从Snap Store获取

安装

启动安装程序并按照指示进行安装。

Windows 选项

在Windows上,您可以通过添加/S标志进行静默安装。您还可以添加以下选项:

  • /S - 静默安装
  • /allusers - 为所有用户安装(需要管理员权限)
  • /currentuser - 仅为当前用户安装(默认)
  • /disableAutoUpdates - 禁用自动更新

开发

快速开始

前提条件:

现在只需克隆并启动应用:

git clone https://github.com/RocketChat/Rocket.Chat.Electron.git
cd Rocket.Chat.Electron
yarn
yarn start

项目结构

源代码位于src文件夹中。使用yarn start运行应用时,此文件夹中的所有内容都将自动构建。

构建过程会编译src文件夹中的所有内容并将其放入app文件夹,因此构建完成后,您的app文件夹将包含完整的可运行应用程序。

TypeScript

遵循[Rocket.Chat代码库的持续变更][],该应用已使用TypeScript 4重写,以解决可维护性问题。

构建流程

构建过程基于rollup打包工具。您的代码有三个入口文件:

  • src/main.ts,在主Electron进程中运行的脚本,用于协调整个应用程序;

  • src/rootWindow.ts,用于渲染根窗口(应用程序的主窗口)UI的脚本;

  • src/preload.ts,在特权模式下运行,用于连接应用程序和渲染Rocket.Chat网页客户端的webview。

添加Node.js模块

请注意区分package.json文件中的dependenciesdevDependencies。只有列在dependencies中的模块才会被包含在可分发的应用程序中。

故障排除

node-gyp

请按照[node-gyp自述文件][]中的安装说明进行操作。

Ubuntu

您需要安装以下软件包:

build-essential
libevas-dev
libxss-dev

Fedora

您需要安装以下软件包:

libX11
libXScrnSaver-devel
gcc-c++

Windows 7

在Windows 7上,您可能需要按照[node-gyp安装指南]的选项2进行操作,并安装Visual Studio。

测试

单元测试

yarn test

我们使用Jest测试框架和Jest electron runner。它会搜索src目录中所有匹配*.(spec|test).{js,ts,tsx}通配模式的文件。

发布版本

要将应用打包成安装程序,请使用以下命令:

yarn release

这将开始为您运行此命令的操作系统进行打包过程。可分发的文件将输出到dist目录。

所有打包操作都由electron-builder处理。它有很多[自定义选项][]。

默认服务器

servers.json文件定义了客户端将连接的服务器,并将填充侧边栏中的服务器列表。它包含一个默认服务器列表,这些服务器将在用户首次运行应用程序时(或当所有服务器从列表中删除时)添加。 文件语法如下:

{
  "Demo Rocket Chat": "https://demo.rocket.chat",
  "Open Rocket Chat": "https://open.rocket.chat"
}

预发布配置

您可以将servers.json与安装包捆绑在一起,该文件应位于项目应用程序的根目录(与package.json同级)。如果找到该文件,将跳过初始的"连接到服务器"屏幕,并尝试连接到数组中定义的第一个服务器,直接将用户带到登录界面。请注意,只有在尚未添加其他服务器的情况下才会检查servers.json,即使您卸载应用程序而不删除旧的首选项,它也不会再次触发。

安装后配置

如果你无法(或不想)将文件打包到应用程序内,你可以在用户首选项文件夹中创建一个servers.json文件,它将覆盖打包的文件。该文件应位于%APPDATA%/Rocket.Chat/文件夹中,或者在为所有用户安装的情况下,位于安装文件夹中(仅限Windows)。

对于Windows,完整路径是:

  • ~\Users\<用户名>\AppData\Roaming\Rocket.Chat\
  • ~\Program Files\Rocket.Chat\Resources\

在macOS上,完整路径是:

  • ~/Users/<用户名>/Library/Application Support/Rocket.Chat/
  • /Library/Preferences/Rocket.Chat/

在Linux上,完整路径是:

  • /home/<用户名>/.config/Rocket.Chat/
  • /opt/Rocket.Chat/resources/

覆盖设置

你可以通过在用户首选项文件夹中创建一个overridden-settings.json文件来覆盖用户设置。 该文件应位于%APPDATA%/Rocket.Chat/文件夹中,或者在为所有用户安装的情况下,位于安装文件夹中(仅限Windows)。

文件中设置的每个设置都将覆盖默认和用户设置。然后你可以使用它来禁用默认功能,如自动更新,甚至创建单服务器模式。

可以被覆盖的设置有:

设置描述
"isReportEnabled": true,设置是否向开发者报告错误。
"isInternalVideoChatWindowEnabled": true,设置视频通话是否在内部窗口中打开。
"isFlashFrameEnabled": true,设置是否启用闪烁框架。
"isMinimizeOnCloseEnabled": false,设置关闭时应用是否最小化。
"doCheckForUpdatesOnStartup": true,设置应用是否在启动时检查更新。
"isMenuBarEnabled": true,设置是否启用菜单栏。
"isTrayIconEnabled": true,启用托盘图标,关闭时应用将隐藏到托盘。覆盖"isMinimizeOnCloseEnabled"
"isUpdatingEnabled": true,设置用户是否可以更新应用。
"isAddNewServersEnabled": true,设置用户是否可以添加新服务器。
单服务器模式

如果设置"isAddNewServersEnabled": false,用户将无法添加新服务器。 按钮和快捷方式将被禁用。然后你将必须将服务器添加到servers.json文件中。 通过这种方式,你可以创建单服务器模式或只是不让用户自己添加新服务器。

示例配置

overridden-settings.json文件:

{
   "isTrayIconEnabled": false,
   "isMinimizeOnCloseEnabled": false
}

isTrayIconEnabled启用时,应用在关闭时将隐藏。 当isMinimizeOnCloseEnabled启用时,应用在关闭时将最小化。 当两者都禁用时,应用在关闭时将退出。

许可证

基于MIT许可证发布。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号