Skip to content

zbreit/zulip-electron

 
 

Repository files navigation

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.

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

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
  • Keyboard shortcuts
Description Keys
Default shortcuts Cmd/Ctrl k
Change Zulip Server Cmd/Ctrl ,
Back Cmd/Ctrl [
Forward Cmd/Ctrl ]
  • 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.

About

💥 Zulip Desktop Client [WIP]

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 56.4%
  • CSS 28.3%
  • HTML 9.4%
  • Shell 5.9%