aaron/mattermost-desktop
1
0
Fork 0
Code Issues Pull requests Actions 1 Packages Projects Releases Wiki Activity
custom mattermost desktop application
710 commits 1 branch 94 tags 43 MiB
TypeScript 54.2%
JavaScript 38.1%
SCSS 4.2%
CSS 2.3%
Shell 0.9%
Other 0.1%
Go to file
Yuya Ochiai 3a8720a9bd Add docs/development.md
2016-09-25 19:45:52 +09:00
circle Merge branch 'master' into dev 2016-06-17 23:39:45 +09:00
docker Use electronuserland/electron-builder image in CircleCI 2016-06-10 00:07:56 +09:00
docs Add docs/development.md 2016-09-25 19:45:52 +09:00
resources Add script to create .desktop file for Linux 2016-08-25 00:33:35 +09:00
script Some minor codestyle improvements due to jshint 2016-08-30 15:28:15 +02:00
src Merge pull request #296 from Razzeee/update-fix-autolaunch 2016-09-21 21:05:24 +09:00
test Fix typo 2016-09-14 00:35:19 +09:00
.editorconfig Force to use LF and add editorconfig 2016-02-26 00:07:04 +09:00
.gitattributes Added gitattributes to keep line endings clean 2016-08-20 22:38:34 +02:00
.gitignore Add .idea to gitignore 2016-08-23 15:20:04 +02:00
CHANGELOG.md Add horizontal lines for visibility of CHANGELOG.md 2016-09-22 23:30:40 +09:00
circle.yml Remove CircleCI deployment task triggered by tag 2016-07-13 01:51:27 +09:00
CONTRIBUTING.md Add request to update CHANGELOG.md and docs/*.md 2016-07-01 01:00:11 +09:00
gulpfile.js Fix wrong condition in npm run package 2016-09-16 20:24:27 +09:00
ISSUE_TEMPLATE.md Update description of Mattermost Menu in issue_template.md 2016-08-16 00:58:40 -04:00
LICENSE Propose updating to Apache v2 2016-06-01 07:46:07 -07:00
package.json Fix ApplicationUserModelID in the start menu shortcut 2016-09-17 00:03:14 +09:00
PULL_REQUEST_TEMPLATE.md Update issue templates 2016-06-16 21:31:03 +09:00
README.md Add docs/development.md 2016-09-25 19:45:52 +09: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.

Mattermost Desktop Screenshot

Circle CI

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.

  1. Download and unarchive a file from release page.
  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. (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>

Contributing

Please see CONTRIBUTING.md.

Development

Please see docs/development.md.