custom mattermost desktop application

Go to file

Yuya Ochiai e99e6c0a05 Update docs for login dialog		2016-04-27 20:51:57 +09:00
circle	Drop `v` from version name when releasing	2016-03-20 23:11:06 +09:00
docker	Fix the script	2016-04-14 23:59:24 +09:00
docs	Update setup.md	2016-04-19 20:36:41 +09:00
resources	Add the status menu for OS X	2016-04-07 00:49:20 +09:00
src	Show proxy URL on login dialog	2016-04-27 20:48:01 +09:00
test	Merge branch 'master' into release/v1.1.0	2016-03-22 23:24:04 +09:00
.editorconfig	Force to use LF and add editorconfig	2016-02-26 00:07:04 +09:00
.gitignore	Use webpack to build	2016-02-09 20:31:37 +09:00
CHANGELOG.md	Update docs for login dialog	2016-04-27 20:51:57 +09:00
circle.yml	Cache the docker image	2016-04-14 23:28:41 +09:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2016-03-23 22:51:52 +09:00
gulpfile.js	Add the dialog to login	2016-04-23 01:12:00 +09:00
ISSUE_TEMPLATE.md	Update ISSUE_TEMPLATE.md	2016-04-11 22:58:27 +09:00
LICENSE	READMEとライセンスを追加	2015-10-10 00:40:41 +09:00
package.json	Update esformatter-jsx and related packages	2016-04-14 22:10:27 +09:00
README.md	Update docs for login dialog	2016-04-27 20:51:57 +09:00
TESTING.md	Fixing incorrect reference to Android device	2016-03-13 08:44:47 -07:00

README.md

Mattermost Desktop (beta)

Native desktop application for Mattermost running on Windows, Mac and Linux.

Originally created as "electron-mattermost" by Yuya Ochiai. Developed using Electron.

Features

Desktop integration

Tabs for multiple teams across multiple servers
Desktop Notifications
- Windows 10: Toast
- Windows 7-8.1: Balloon (fallback behavior, so lesser support)
- OS X: Notification Center
- Linux: libnotify
Badges for unread channels and mentions
Installs as native application

Pre-packaged

You don't have to install any other software. Packages are available on the releases page.

Usage

Installation

Detailed guides are available at docs/setup.md.

Download and unarchive a file from release page.
Launch Mattermost in the unarchived folder.
After first launching, please input name and URL for your Mattermost team. For example, myteam : https://mattermost.example.com/team.

Quit

Ctrl or Command + Q to quit.

Configuration

You can show the dialog from menu bar. (Please press Alt key to show the menu bar if it disappers.)

Configuration will be saved into Electron's userData directory:

%APPDATA%\Mattermost on Windows
~/Library/Application Support/Mattermost on OS X
~/.config/Mattermost on Linux

When you upgrade from electron-mattermost, please copy config.json from electron-mattermost. Otherwise, you have to configure again.

Proxy

Normally, the application will follow your system settings to use proxy. Or you can set proxy by following command line options.

--proxy-server=<SERVER>:<PORT>
--proxy-pac-url=<URL>

Testing and Development

Node.js is required to test this app.

Simple testing

Clone or download the source code.
Run npm install.
Run npm start.

When you edit src/** files, please execute npm run build before npm start.

Development

`npm run watch`

Reload the app automatically when you have saved source codes.

`npm test`

Run tests with Mocha.

Packaging

You can package this app with following commands. Packages will be created in release directory.

$ npm run package (for your platform)
$ npm run package:windows (Requires Windows or Wine)
$ npm run package:osx (Requires OS X or Linux)
$ npm run package:linux
$ npm run package:all (Packages for all platform)

Contributing

Please see CONTRIBUTING.md.