mirror of
https://github.com/zulip/zulip-desktop.git
synced 2025-11-02 13:03:22 +00:00
92 lines
3.1 KiB
Markdown
92 lines
3.1 KiB
Markdown
# Zulip Desktop Client
|
|
[](https://travis-ci.org/zulip/zulip-electron)
|
|
[](https://ci.appveyor.com/project/akashnimare/zulip-electron/branch/master)
|
|
[](https://github.com/sindresorhus/xo)
|
|
|
|
Desktop client for Zulip. Available for Mac, Linux and Windows.
|
|
<img src="http://i.imgur.com/bDtK47q.png"/>
|
|
|
|
## Prerequisites
|
|
* node >= v6.3.1
|
|
> Use [nvm](https://github.com/creationix/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:
|
|
```sh
|
|
$ sudo apt-get install build-essential libxext-dev libxtst-dev libxkbfile-dev
|
|
```
|
|
|
|
## Installation
|
|
|
|
Clone the source locally:
|
|
|
|
```sh
|
|
$ git clone https://github.com/zulip/zulip-electron
|
|
$ cd zulip-electron
|
|
```
|
|
|
|
Install project dependencies:
|
|
|
|
```sh
|
|
$ npm install
|
|
```
|
|
Start the app:
|
|
|
|
```sh
|
|
$ npm start
|
|
```
|
|
|
|
Start and watch changes
|
|
|
|
```sh
|
|
$ 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.
|
|
|
|
# Download
|
|
|
|
* [macOS](https://github.com/zulip/zulip-electron/releases/download/v0.5.10/Zulip-0.5.10.dmg)
|
|
* Linux:
|
|
* [AppImage](https://github.com/zulip/zulip-electron/releases/download/v0.5.10/Zulip-0.5.10-x86_64.AppImage) (Recommended)
|
|
Needs to be [made executable](http://discourse.appimage.org/t/how-to-make-an-appimage-executable/80) after download.
|
|
* [deb](https://github.com/zulip/zulip-electron/releases/download/v0.5.10/Zulip_0.5.10_amd64.deb)
|
|
* Windows:
|
|
* [Installer](https://github.com/zulip/zulip-electron/releases/download/v0.5.10/Zulip.Web.Setup.0.5.10.exe)
|
|
* Zip
|
|
* [64bit](https://github.com/zulip/zulip-electron/releases/download/v0.5.10/zulip-0.5.10-x64.nsis.7z)
|
|
* [32bit](https://github.com/zulip/zulip-electron/releases/download/v0.5.10/zulip-0.5.10-ia32.nsis.7z)
|
|
|
|
|
|
|
|
## Features
|
|
- [x] Multi account support
|
|
- [x] Native Notifications
|
|
- [x] SpellChecker
|
|
- [x] OSX/Win/Linux installer
|
|
- [x] Automatic Updates (macOS/Windows)
|
|
- [x] Keyboard shortcuts
|
|
|
|
Description | Keys
|
|
-----------------------| -----------------------
|
|
Default shortcuts | <kbd>Cmd/Ctrl</kbd> <kbd>k</kbd>
|
|
Change Zulip Server | <kbd>Cmd/Ctrl</kbd> <kbd>,</kbd>
|
|
Back | <kbd>Cmd/Ctrl</kbd> <kbd>[</kbd>
|
|
Forward | <kbd>Cmd/Ctrl</kbd> <kbd>]</kbd>
|
|
|
|
|
|
## Contribute
|
|
|
|
If you want to contribute please make sure to read [our documentation about contributing](./CONTRIBUTING.md) first.
|
|
|
|
* [Issue Tracker](https://github.com/zulip/zulip-electron/issues)
|
|
* [Source Code](https://github.com/zulip/zulip-electron/)
|