Development guide

Prerequisites

Git
Node.js >= v6.9.0
python (v2.7.x recommended)
node-gyp

System specific dependencies

Linux

Install following packages:

$ sudo apt-get install build-essential libxext-dev libxtst-dev libxkbfile-dev

Installation

Clone the source locally:

$ git clone https://github.com/zulip/zulip-electron
$ cd zulip-electron

Install project dependencies:

$ npm install

Start the app:

$ npm start

Start and watch changes

$ npm run dev

Making a release

To package app into an installer use command:

npm run dist

It will start the packaging process for the operating system you are running this command on. The ready for distribution file (e.g. dmg, windows installer, deb package) will be outputted to the dist directory.

You can create a Windows installer only when running on Windows and similarly for Linux and OSX. So, to generate all three installers, you will need all three operating systems.

Troubleshooting

If you have any problems running the app please see the most common issues.

1.3 KiB Raw Blame History