Desktop client for Zulip. Available for Mac, Linux and Windows.

• node >= v6.3.1

Use nvm to install the current stable version of node

• python (v2.7.x recommended)
• If you're on Debian or Ubuntu, you'll need to install following packages:

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

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

To package app into an installer use command:

npm run dist

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

You can create Windows installer only when running on Windows, the same is true for Linux and OSX. So to generate all three installers you need all three operating systems.

• macOS
• Linux:
  • AppImage (Recommended) Needs to be made executable after download.
  • deb
• Windows:
  • Installer
  • Zip
    • 64bit
    • 32bit

• Multi account support
• Native Notifications
• SpellChecker
• OSX/Win/Linux installer
• Automatic Updates (macOS/Windows)
• Keyboard shortcuts

If you want to contribute please make sure to read our documentation about contributing first.

• Issue Tracker
• Source Code