Desktop App Environment Setup

The Rocket.Chat multiplatform client desktop app is developed with Electron.
Setting up the development environment requires you to download and install multiple dependencies. You will need an active internet connection throughout the process.
Requirements
You are required to have the following installed already on your machine before starting. If you don't, please take a minute and get them ready.
​Git​
​Node.js​
​node-gyp​
​Yarn is recommended instead of npm.
Get the Code
1.Open up your terminal/command line and navigate or cd into your working directory.
cd ./working-directory
2. Clone the source code from our repository and run it by executing the following script on your terminal.
git clone https://github.com/RocketChat/Rocket.Chat.Electron.git
cd Rocket.Chat.Electron
yarn
yarn start
Project Structure
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.
Rocket.Chat.Electron
├── build
│   └── icons
├── src
│   ├── app
│   │   ├── main
│   │   └── reducers
│   ├── deepLinks
│   ├── downloads
│   │   └── reducers
│   ├── i18n
│   ├── ipc
│   ├── jitsi
│   ├── navigation
│   ├── notifications
│   ├── public
│   │   └── images
│   │       ├── touch-bar
│   │       └── tray
│   │           ├── darwin
│   │           ├── linux
│   │           └── win32
│   ├── screenSharing
│   ├── servers
│   │   └── preload
│   ├── spellChecking
│   ├── store
│   ├── types
│   ├── ui
│   │   ├── assets
│   │   ├── components
│   │   │   ├── AboutDialog
│   │   │   ├── AddServerView
│   │   │   ├── Dialog
│   │   │   ├── DownloadsManagerView
│   │   │   ├── ScreenSharingDialog
│   │   │   ├── SelectClientCertificateDialog
│   │   │   ├── ServersView
│   │   │   ├── SettingsView
│   │   │   │   └── features
│   │   │   ├── Shell
│   │   │   ├── SideBar
│   │   │   ├── UpdateDialog
│   │   │   └── utils
│   │   ├── icons
│   │   ├── main
│   │   │   └── serverView
│   │   ├── preload
│   │   └── reducers
│   ├── updates
│   └── userPresence
└── workspaces
    └── desktop-release-action
        ├── dist
        └── src

Mobile App - Previous

Mobile App FAQs

Next - Desktop App

Developing your Desktop App

Last modified 1mo ago

Export as PDF

Copy link

Edit on GitHub

Outline

Requirements

Get the Code

Project Structure