phlux/mattermostest
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge branch 'master' into release/v1.1.0

Browse Source
This commit is contained in:
Yuya Ochiai
2016-03-22 23:24:04 +09:00
parent 960c5782bd ef8eebc8d0
commit ab18e33f7f
25 changed files with 229 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@@ -1,44 +1,54 @@
# electron-mattermost
[![Circle CI](https://circleci.com/gh/yuya-oc/electron-mattermost.svg?style=svg)](https://circleci.com/gh/yuya-oc/electron-mattermost)
# Mattermost Desktop (beta)
[Electron](http://electron.atom.io/)-based desktop application for [Mattermost](http://www.mattermost.org/)
Native desktop application for [Mattermost](http://www.mattermost.org/) running on Windows, Mac and Linux.
Originally created as "electron-mattermost" by Yuya Ochiai. Developed using [Electron](http://electron.atom.io/).
![Mattermost Desktop Screenshot](docs/20160309_mattermost-desktop.gif)
[![Circle CI](https://circleci.com/gh/mattermost/desktop.svg?style=svg)](https://circleci.com/gh/mattermost/desktop)
## Features
### Desktop integration
* Tabs for multiple teams
* Desktop Notification
* 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 ([Electron's notification spec](http://electron.atom.io/docs/v0.36.0/tutorial/desktop-environment-integration/#linux))
* Badges for unread channels and mention
* Resident application
* Linux: [libnotify](http://electron.atom.io/docs/v0.36.0/tutorial/desktop-environment-integration/#linux)
* Badges for unread channels and mentions
* Installs as native application
### Pre-packaged
You don't have to install any other software.
Packages are available at [release page](http://github.com/yuya-oc/electron-mattermost/releases).
Packages are available on the [releases page](http://github.com/mattermost/desktop/releases).
## Usage
### Installation
Detailed guides are available at [docs/setup.md](docs/setup.md).
1. Download and unarchive a file from [release page](http://github.com/yuya-oc/electron-mattermost/releases).
2. Launch `electron-mattermost` in the unarchived folder.
3. After first launching, please input name and URL for your Mattermost team. For example, `myteam : http://mattermost.example.com/team`.
1. Download and unarchive a file from [release page](http://github.com/mattermost/desktop/releases).
2. Launch `Mattermost` in the unarchived folder.
3. 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.
(On Windows, please press Alt key to show the menu bar.)
(Please press Alt key to show the menu bar if it disappers.)
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
* `%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.
@@ -61,10 +71,10 @@ Node.js is required to test this app.
When you edit `src/**` files, please execute `npm run build` before `npm start`.
### Development
#### `npm run watch`
###### `npm run watch`
Reload the app automatically when you have saved source codes.
#### `npm test`
###### `npm test`
Run tests with Mocha.
## Packaging
@@ -77,3 +87,6 @@ $ 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](./CONTRIBUTING.md).