custom mattermost desktop application

Go to file

Yuya Ochiai a360b3fa3d Avoid docker-build error on pull request in CircleCI $CIRCLE_USERNAME might be different on pull request. As result, CircleCI fails in this case. The docker image is temporary for building apps. So the fixed image name is used to avoid this issue.		2015-12-31 13:25:16 +09:00
circle	Automate release draft	2015-12-12 01:55:00 +09:00
docker	Update Electron to 0.36.2	2015-12-27 00:55:21 +09:00
resources	ディレクトリの整理	2015-11-03 18:39:43 +09:00
src	Fix jp_fonts for mattermost	2015-12-27 17:06:14 +09:00
test	Add simple tests for settings.html	2015-12-27 16:12:20 +09:00
.gitignore	Improve development files	2015-12-24 23:41:42 +09:00
circle.yml	Avoid docker-build error on pull request in CircleCI	2015-12-31 13:25:16 +09:00
gulpfile.js	Add missing dependency for build	2015-12-26 00:00:27 +09:00
LICENSE	READMEとライセンスを追加	2015-10-10 00:40:41 +09:00
package.json	Update Electron to 0.36.2	2015-12-27 00:55:21 +09:00
README.md	Update README.md	2015-12-27 17:20:56 +09:00
TODO.md	Add TODO.md	2015-12-06 17:30:33 +09:00

README.md

electron-mattermost

Electron-based desktop application for Mattermost

Features

Desktop integration

Tabs for multiple teams
Notifications
- Desktop Notification
  - Windows 10: Toast
  - Windows 7-8.1: Balloon
  - OS X: Notification Center
  - Linux: libnotify (Electron's notification spec)
- Badges for unread channels
Resident application

Pre-packaged

You don't have to install any other software.

Usage

Installation

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

Quit

Ctrl or Command + Q to quit.

Configuration

You can show the dialog from menu bar. (On Windows, please press Alt key to show the menu bar.)

Configuration will be saved into Electron's userData directory:

%APPDATA%\electron-mattermost on Windows
~/Library/Application Support/electron-mattermost on OS X
~/.config/electron-mattermost on Linux

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 .jsx files, please execute npm run build before npm start.

Development

`npm run serve`

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)