2015-10-09 08:40:41 -07:00
|
|
|
# electron-mattermost
|
2015-11-03 03:49:53 -08:00
|
|
|
Desktop app for [Mattermost](http://www.mattermost.org/) that runs on [Electron](http://electron.atom.io/)
|
2015-10-24 05:53:17 -07:00
|
|
|
|
2015-11-14 04:23:27 -08:00
|
|
|
|
2015-11-03 03:49:53 -08:00
|
|
|
## Features
|
2015-11-14 04:23:27 -08:00
|
|
|
|
|
|
|
|
### Desktop integration
|
2015-11-03 03:49:53 -08:00
|
|
|
* Badges for unread channels
|
2015-11-14 04:23:27 -08:00
|
|
|
* Notification
|
|
|
|
|
* Windows: Balloon or Toast
|
|
|
|
|
* OS X: Notification Center
|
|
|
|
|
* Resident application
|
|
|
|
|
|
|
|
|
|
### Pre-packaged
|
|
|
|
|
You don't have to install any other software.
|
|
|
|
|
|
2015-11-03 03:49:53 -08:00
|
|
|
|
|
|
|
|
## Usage
|
2015-11-14 04:23:27 -08:00
|
|
|
|
|
|
|
|
### Installation
|
2015-11-03 03:49:53 -08:00
|
|
|
1. Download and unarchive a file from [release page](http://github.com/yuya-oc/electron-mattermost/releases).
|
|
|
|
|
2. Launch electron-mattermost.exe or electron-mattermost.app
|
|
|
|
|
3. After first launching, please input URL for your Mattermost team. For exmaple, `http://mattermost.example.com/team`.
|
|
|
|
|
|
2015-11-14 04:23:27 -08:00
|
|
|
### Quit
|
|
|
|
|
Ctrl or Command + Q to quit.
|
|
|
|
|
|
|
|
|
|
### Configuration
|
2015-11-03 03:49:53 -08:00
|
|
|
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
|
|
|
|
|
|
2015-11-14 04:23:27 -08:00
|
|
|
|
2015-11-03 03:49:53 -08:00
|
|
|
## Testing
|
|
|
|
|
Node.js is required to test this app.
|
|
|
|
|
|
|
|
|
|
1. Clone or download the source code.
|
|
|
|
|
2. Run `npm install`.
|
|
|
|
|
3. Run `npm start`. (If you have gulp, `gulp serve` has live-reload.)
|
2015-11-09 07:35:35 -08:00
|
|
|
|
2015-11-14 04:23:27 -08:00
|
|
|
|
2015-11-09 07:35:35 -08:00
|
|
|
## Packaging
|
|
|
|
|
gulp is necessary for packaging this app.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ npm install -g gulp (Or, use node_module/gulp/bin/gulp.js
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
You can package this app with following commands. Packages will be created in `release` directory.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ gulp package:windows (Requires Windows or Wine)
|
|
|
|
|
$ gulp package:osx (Requires OS X or Linux)
|
|
|
|
|
$ gulp package:linux
|
|
|
|
|
$ gulp package (Packages for all platform)
|
|
|
|
|
```
|
