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.
1
cd ./working-directory
Copied!
   2. Clone the source code from our repository and run it by executing the following script on your terminal.
1
git clone https://github.com/RocketChat/Rocket.Chat.Electron.git
2
cd Rocket.Chat.Electron
3
yarn
4
yarn start
Copied!
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.
1
Rocket.Chat.Electron
2
├── build
3
│   └── icons
4
├── src
5
│   ├── app
6
│   │   ├── main
7
│   │   └── reducers
8
│   ├── deepLinks
9
│   ├── downloads
10
│   │   └── reducers
11
│   ├── i18n
12
│   ├── ipc
13
│   ├── jitsi
14
│   ├── navigation
15
│   ├── notifications
16
│   ├── public
17
│   │   └── images
18
│   │       ├── touch-bar
19
│   │       └── tray
20
│   │           ├── darwin
21
│   │           ├── linux
22
│   │           └── win32
23
│   ├── screenSharing
24
│   ├── servers
25
│   │   └── preload
26
│   ├── spellChecking
27
│   ├── store
28
│   ├── types
29
│   ├── ui
30
│   │   ├── assets
31
│   │   ├── components
32
│   │   │   ├── AboutDialog
33
│   │   │   ├── AddServerView
34
│   │   │   ├── Dialog
35
│   │   │   ├── DownloadsManagerView
36
│   │   │   ├── ScreenSharingDialog
37
│   │   │   ├── SelectClientCertificateDialog
38
│   │   │   ├── ServersView
39
│   │   │   ├── SettingsView
40
│   │   │   │   └── features
41
│   │   │   ├── Shell
42
│   │   │   ├── SideBar
43
│   │   │   ├── UpdateDialog
44
│   │   │   └── utils
45
│   │   ├── icons
46
│   │   ├── main
47
│   │   │   └── serverView
48
│   │   ├── preload
49
│   │   └── reducers
50
│   ├── updates
51
│   └── userPresence
52
└── workspaces
53
    └── desktop-release-action
54
        ├── dist
55
        └── src
Copied!

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

Contents

Requirements

Get the Code

Project Structure