zulip-desktop/README.md

Zulip Desktop Client

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.

Installation

Clone the source locally:

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

If you're on Debian or Ubuntu, you'll also need to install nodejs-legacy:

Use your package manager to install npm.

$ sudo apt-get install npm nodejs-legacy

Install project dependencies:

$ npm install

Start the app:

$ npm start

Start and watch changes

$ npm run dev

Features

• Native Notifications
• Spell Checker
• Keyboard Shortcuts
• Default shortcuts - cmdOrctrl + k
• Change Zulip Server: cmdOrctrl + ,
• Back: cmdOrctrl + [
• Forward: cmdOrctrl + ]
• OSX/Win/Linux installer
• Launch on OS startup
• Automatic Updates

Contribute

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

• Issue Tracker
• Source Code