2015-10-09 08:40:41 -07:00
|
|
|
# electron-mattermost
|
2015-12-27 00:20:56 -08:00
|
|
|
[](https://circleci.com/gh/yuya-oc/electron-mattermost)
|
2015-10-24 05:53:17 -07:00
|
|
|
|
2015-12-27 00:20:56 -08:00
|
|
|
[Electron](http://electron.atom.io/)-based desktop application for [Mattermost](http://www.mattermost.org/)
|
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-12-25 07:02:19 -08:00
|
|
|
* Tabs for multiple teams
|
2015-12-27 00:20:56 -08:00
|
|
|
* Notifications
|
|
|
|
|
* Desktop Notification
|
|
|
|
|
* Windows 10: Toast
|
|
|
|
|
* Windows 7-8.1: Balloon
|
|
|
|
|
* OS X: Notification Center
|
|
|
|
|
* Linux: libnotify ([Electron's notification spec](http://electron.atom.io/docs/v0.36.0/tutorial/desktop-environment-integration/#linux))
|
|
|
|
|
* Badges for unread channels
|
2015-11-14 04:23:27 -08:00
|
|
|
* 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
|
2016-01-16 00:10:37 -08:00
|
|
|
Detailed guides are available at [docs/setup.md](docs/setup.md).
|
|
|
|
|
|
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).
|
2015-12-06 01:20:07 -08:00
|
|
|
2. Launch `electron-mattermost` in the unarchived folder.
|
2016-01-16 00:10:37 -08:00
|
|
|
3. After first launching, please input name and URL for your Mattermost team. For example, `myteam : http://mattermost.example.com/team`.
|
2015-11-03 03:49:53 -08:00
|
|
|
|
2015-11-14 04:23:27 -08:00
|
|
|
### Quit
|
|
|
|
|
Ctrl or Command + Q to quit.
|
|
|
|
|
|
|
|
|
|
### Configuration
|
2015-12-27 00:20:56 -08:00
|
|
|
You can show the dialog from menu bar.
|
|
|
|
|
(On Windows, please press Alt key to show the menu bar.)
|
|
|
|
|
|
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-12-25 07:02:19 -08:00
|
|
|
## Testing and Development
|
2015-11-03 03:49:53 -08:00
|
|
|
Node.js is required to test this app.
|
|
|
|
|
|
2015-12-25 07:02:19 -08:00
|
|
|
### Simple testing
|
2015-11-03 03:49:53 -08:00
|
|
|
1. Clone or download the source code.
|
|
|
|
|
2. Run `npm install`.
|
2015-12-25 07:02:19 -08:00
|
|
|
3. Run `npm start`.
|
2015-11-09 07:35:35 -08:00
|
|
|
|
2016-02-09 03:59:52 -08:00
|
|
|
When you edit `src/**` files, please execute `npm run build` before `npm start`.
|
2015-11-14 04:23:27 -08:00
|
|
|
|
2015-12-25 07:02:19 -08:00
|
|
|
### Development
|
2016-02-09 03:59:52 -08:00
|
|
|
#### `npm run watch`
|
2015-12-25 07:02:19 -08:00
|
|
|
Reload the app automatically when you have saved source codes.
|
2015-11-09 07:35:35 -08:00
|
|
|
|
2015-12-25 07:02:19 -08:00
|
|
|
#### `npm test`
|
|
|
|
|
Run tests with Mocha.
|
2015-11-09 07:35:35 -08:00
|
|
|
|
2015-12-25 07:02:19 -08:00
|
|
|
## Packaging
|
2015-11-09 07:35:35 -08:00
|
|
|
You can package this app with following commands. Packages will be created in `release` directory.
|
|
|
|
|
|
|
|
|
|
```
|
2015-12-25 07:02:19 -08:00
|
|
|
$ 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)
|
2015-11-09 07:35:35 -08:00
|
|
|
```
|
