Files
zulip-desktop/README.md
2017-05-24 15:21:12 -07:00

2.6 KiB

Zulip Desktop Client

Build Status Windows Build Status XO code style

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

Download

You can download the latest version from the Releases page.

Prerequisites

  • 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

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

  • Multiple Zulip server support
  • Native desktop Notifications
  • SpellChecker
  • OSX/Win/Linux installers
  • Automatic Updates (macOS/Windows)
  • Keyboard shortcuts
Description Keys
Default shortcuts Cmd/Ctrl k
Manage Zulip Servers Cmd/Ctrl ,
Back Cmd/Ctrl [
Forward Cmd/Ctrl ]

Contribute

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

Troubleshooting

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