RocketChat/Rocket.Chat.Electron — 1.7k★ trên GitHub (TypeScript). The Secure CommsOS™ for mission-critical operations
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
Desktop application for Rocket.Chat available for macOS, Windows and Linux
using Electron.
Supported Platforms
Platform
Minimum Version
Architectures
Formats
Windows
10
x64, ia32, arm64
NSIS, MSI
macOS
12 (Monterey)
Universal (x64 + Apple Silicon)
DMG, PKG, ZIP
Linux
Ubuntu 22.04+ or equivalent
x64
AppImage, deb, rpm, snap, tar.gz
Engage with us
Share your story
We'd love to hear about your experience and potentially feature it on our
Blog.
Subscribe for Updates
Once a month our marketing team releases an email update with news about product
releases, company related topics, events and use cases. Sign Up!
Download
You can download the latest version from the Releases page.
Install
Launch the installer and follow the instructions to install.
Windows Options
On Windows you can run a silent install by adding the /S flag. You can also
add the options below:
/S - Silent install
/allusers - Install for all users (requires admin)
/currentuser - Install only for the current user (default)
/disableAutoUpdates - Disable automatic updates
Development
Quick start
Prerequisites:
Git
Node.js >= 22.0.0
Yarn >= 4.0.2
Now just clone and start the app:
git clone https://github.com/RocketChat/Rocket.Chat.Electron.git
cd Rocket.Chat.Electron
yarn
yarn start
Structure of the project
The source is located in the src folder. Everything in this folder will be
built automatically when running the app with yarn start.
The build process compiles all stuff from the src folder and puts it into the
app folder, so after the build has finished, your app folder contains the
full, runnable application.
TypeScript
Following the ongoing changes in Rocket.Chat codebase, the app was
rewritten in TypeScript 5 to address issues regarding maintainability.
The build pipeline
The build process is founded upon rollup bundler. There are three entry files
for your code:
src/main.ts, the script running at the main Electron process, orchestrating
the whole application;
src/rootWindow.ts, the script that renders the UI of the root window, the
app's main window;
and src/preload.ts, which runs in a privileged mode to connect the app and
the webviews rendering Rocket.Chat's web client.
Adding Node.js modules
Remember to respect the split between dependencies and devDependencies in
package.json file. Only modules listed in dependencies will be included into
distributable app.
Troubleshooting
Ubuntu/Debian
You may need to install the following packages for development:
sudo apt install build-essential libxss-dev
Fedora/RHEL
You may need to install the following packages for development:
We use Jest testing framework with the Jest electron runner. It searches
for all files in src directory that match the glob pattern
*.(spec|test).{js,ts,tsx}.
Making a release
To package your app into an installer use command:
yarn release
It will start the packaging process for operating system you are running this
command on. Ready for distribution file will be outputted to dist directory.
All packaging actions are handled by electron-builder. It has a lot of
customization options.
Development and Releases
All pull requests target dev. master contains only released code, and
its tip is always the latest stable release. release/X.Y.x branches carry
patch releases for a shipped version, and merge into master after each
patch.
Releases are tag-driven — pushing a semver tag triggers CI to build every
platform and draft a GitHub release, which a human then reviews and
publishes.
docs/development-and-release-flow.md — conceptual overview of the
branch model, versioning, and CI/CD.
docs/release-process.md — operational runbook with the exact commands
for cutting alpha, stable, and patch releases.
.github/CONTRIBUTING.md — contribution guidelines, including which
branch to target.
Default servers
The servers.json file will define what servers the client will connect to and
will populate the server list in the sidebar. It contains a list of default
servers which will be added the first time the user runs the app (or when all
servers are removed from the list).
The file syntax is as follows:
You can bundle a servers.json with the install package, the file should be
located in the root of the project application (same level as the
package.json). If the file is found, the initial "Connect to server" screen
will be skipped and it will attempt to connect to the first server in the array
that has been defined and drop the user right at the login screen. Note that the
servers.json will only be checked if no other servers have already been added,
even if you uninstall the app without removing older preferences, it will not be
triggered again.
Post-Install Configuration
If you can't (or don't want to) bundle the file inside the app, you can create a
servers.json in the user preferences folder which will overwrite the packaged
one. The file should be located in the %APPDATA%/Rocket.Chat/ folder or the
installation folder in case of an installation for all users (Windows only).
You can override the user settings by creating an overridden-settings.json in
the user preferences folder.
The file should be located in the %APPDATA%/Rocket.Chat/ folder or the
installation folder in case of an installation for all users (Windows only).
Every setting set on the file will override the default and user settings. Then
you can use it for disabling the default features like auto-update and even create
a single server mode.
The settings that can be overridden are:
Setting
Description
"isReportEnabled": true
Sets if the bugs will be reported to developers.
"isInternalVideoChatWindowEnabled": true
Sets if video calls will be opened in an internal window.
"isFlashFrameEnabled": true
Sets if the flash frame will be enabled.
"isMinimizeOnCloseEnabled": false
Sets if the app will be minimized on close.
"doCheckForUpdatesOnStartup": true
Sets if the app will check for updates on startup.
"isMenuBarEnabled": false
Windows/Linux: true keeps the menu bar always visible; false auto-hides it (Alt shows it temporarily). Unused on macOS.
"isTrayIconEnabled": true
Enables Tray Icon, the app will be hidden to the tray on close. Overrides "isMinimizeOnCloseEnabled"
"isUpdatingEnabled": true
Sets if the app can be updated by the user.
"isAddNewServersEnabled": true
Sets if the user can add new servers.
"isNotificationQuickReplyEnabled": true
Sets if notifications are created with an inline reply field. When set to false, notifications are created without the inline reply field (Windows/macOS).
Single server mode
If the setting "isAddNewServersEnabled": false is set, the user will not be able to add new servers.
The buttons and shortcuts will be disabled. Then you will have to add the server to the servers.json file.
With this, you can create a single server mode or just don't let the user add new servers on their own.
If isTrayIconEnabled is enabled, the app will be hidden on close.
If isMinimizeOnCloseEnabled is enabled, the app will be minimized on close.
With both disabled, the app will quit on close.
Đọc thêm về RocketChat/Rocket.Chat.Electron ở đâu?
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/RocketChat/Rocket.Chat.Electron là nguồn chính thức.
RocketChat/Rocket.Chat.Electron có bao nhiêu sao?
RocketChat/Rocket.Chat.Electron có 1.7k sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/RocketChat/Rocket.Chat.Electron. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
RocketChat/Rocket.Chat.Electron có những chủ đề gì?
RocketChat/Rocket.Chat.Electron có phải mã nguồn mở không?
Có — RocketChat/Rocket.Chat.Electron phát hành theo license MIT, nghĩa là mã nguồn mở để đọc, fork và (tùy license) tái sử dụng. Mã: github.com/RocketChat/Rocket.Chat.Electron.
RocketChat/Rocket.Chat.Electron có trang demo không?
Dự án có trang chủ ở https://rocket.chat/. Tab "Readme" ở trang này thường có ảnh chụp và hướng dẫn bắt đầu nhanh.
RocketChat/Rocket.Chat.Electron còn đang phát triển không?
Commit gần nhất trên RocketChat/Rocket.Chat.Electron là 13 ngày trước (theo timestamp GitHub). Repo có 846 fork — một chỉ báo về mức độ quan tâm của cộng đồng.
Đọc đầy đủ README ở tab phía trên.
Muốn nghe thêm một ý kiến về Rocket.Chat.Electron?
Hỏi một AI đọc được trang này — một cú bấm là có ngay nhận định về Rocket.Chat.Electron.