πŸ’₯ Zulip Desktop Client [WIP]
JavaScript CSS HTML Shell

README.md

Zulip Desktop Client

Build Status Windows Build Status XO code style

This is an experimental replacement for the Zulip Desktop app implemented in Electron.

The goal is to achieve feature-compatibility with the old desktop app and then start adding cool features like easy support for multi-account, auto-updates etc.

Prerequisites

  • node >= v6.3.1
  • npm >= 3.10.3
  • python (v2.7.x recommended)
  • If you're on Debian or Ubuntu, you'll need to install following packages:
$ sudo apt-get install nodejs-legacy 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 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.

Features

  • Native Notifications
  • SpellChecker
  • OSX/Win/Linux installer
  • Automatic Updates (macOS/Windows)
  • Keyboard shortcuts
Description Keys
Default shortcuts Cmd/Ctrl k
Change Zulip Server Cmd/Ctrl ,
Back Cmd/Ctrl [
Forward Cmd/Ctrl ]

Contribute

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