custom mattermost desktop application

Go to file

Yuya Ochiai 84c1ac1d9b Merge pull request #164 from Razzeee/auto-launch-option Adds a setting to launch the app on system login		2016-06-16 20:05:35 +09:00
circle	Fix arch name for .deb packages in deploy script	2016-06-12 23:26:32 +09:00
docker	Update Electron to 0.37.7	2016-04-27 22:16:12 +09:00
docs	Update docs/setup.md	2016-06-05 20:46:17 +09:00
resources	Use electron-builder to create deb packages	2016-04-26 22:40:30 +09:00
script	Implement installers via electron-builder	2016-05-20 22:58:32 +02:00
src	Adds a setting to launch the app on system login	2016-06-15 17:23:10 +02:00
test	Add tests for hideMenuBar	2016-05-03 00:42:13 +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 README.md	2016-06-05 20:44:04 +09:00
circle.yml	Remove unnecessary commands from circle.yml	2016-05-02 19:38:11 +09:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2016-03-23 22:51:52 +09:00
gulpfile.js	Change package entry for electron-builder. See https://github.com/mattermost/desktop/pull/138#discussion_r63242703	2016-06-12 13:53:18 +02:00
ISSUE_TEMPLATE.md	Update ISSUE_TEMPLATE.md	2016-04-11 22:58:27 +09:00
LICENSE	Propose updating to Apache v2	2016-06-01 07:46:07 -07:00
package.json	Change package entry for electron-builder. See https://github.com/mattermost/desktop/pull/138#discussion_r63242703	2016-06-12 13:53:18 +02:00
README.md	Implement installers via electron-builder	2016-05-20 22:58:32 +02: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)

Create a windows installer with the following command. It will appear in the release\windows-installer directory.

$ npm run installer

Contributing

Please see CONTRIBUTING.md.