https://github.com/mattermost/desktop

Mattermost Desktop application for Windows, Mac and Linux
https://github.com/mattermost/desktop

desktop electron hacktoberfest mattermost mattermost-desktop mattermost-desktop-application

Last synced: 20 days ago
JSON representation

Mattermost Desktop application for Windows, Mac and Linux

• Host: GitHub
• URL: https://github.com/mattermost/desktop
• Owner: mattermost
• License: apache-2.0
• Created: 2015-10-09T15:35:26.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-15T04:07:03.000Z (20 days ago)
• Last Synced: 2024-10-15T06:04:47.089Z (20 days ago)
• Topics: desktop, electron, hacktoberfest, mattermost, mattermost-desktop, mattermost-desktop-application
• Language: TypeScript
• Homepage:
• Size: 44.7 MB
• Stars: 2,003
• Watchers: 102
• Forks: 823
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Security: SECURITY.md

Awesome Lists containing this project

• Awesome - Mattermost Desktop Client
• awesome-electron - Mattermost - Mattermost client. (Apps / Open Source)
• awesome-electron-zh - Mattermost - Mattermost client. (Apps / Open Source)
• awesome-electron - Mattermost - Mattermost client.  (Apps / Unofficial Apps)

README

        
# Mattermost Desktop

[Mattermost](https://mattermost.com) is an open source platform for secure collaboration across the entire software development lifecycle. This repo is for the native desktop application that's built on [Electron](http://electron.atom.io/); it runs on Windows, Mac, and Linux.

Originally created as "electron-mattermost" by Yuya Ochiai.

![mm-desktop-screenshot](https://user-images.githubusercontent.com/52460000/146078917-e1ba8c1f-24e5-4613-8b4b-f3507422f4f2.png)

[![nightly-builds](https://github.com/mattermost/desktop/actions/workflows/nightly-builds.yaml/badge.svg)](https://github.com/mattermost/desktop/actions/workflows/nightly-builds.yaml)

## Features

### Desktop integration

* Server dropdown for access to multiple servers

* Dedicated tabs for Channels, Boards and Playbooks

* Desktop Notifications

* Badges for unread channels and mentions

* Deep Linking to open Mattermost links directly in the app

* Runs in background to reduce number of open windows

## Usage

### Installation

Detailed guides are available at [docs.mattermost.com](https://docs.mattermost.com/install/desktop-app-install.html).

1. Download a file from the [downloads page](https://mattermost.com/download/#mattermostApps) or from the [releases page](https://github.com/mattermost/desktop/releases).

2. Run the installer or unzip the archive.

3. Launch Mattermost from your Applications folder, menu, or the unarchived folder.

3. On the first launch, please enter a name and URL for your Mattermost server. For example, `https://mattermost.example.com`.

### Configuration

You can show the dialog from menu bar.

Configuration will be saved into Electron's userData directory:

* `%APPDATA%\Mattermost` on Windows

* `~/Library/Application Support/Mattermost` on OS X

* `~/.config/Mattermost` on Linux

A custom data directory location can be specified with:

* `Mattermost.exe --args --data-dir C:\my-mattermost-data` on Windows

* `open /Applications/Mattermost.app/ --args --data-dir ~/my-mattermost-data/` on macOS 

* `./mattermost-desktop --args --data-dir ~/my-mattermost-data/` on Linux

## Custom App Deployments

Our [docs provide a guide](https://docs.mattermost.com/deployment/desktop-app-deployment.html) on how to customize and distribute your own Mattermost Desktop App, including how to distribute the official Windows Desktop App silently to end users, pre-configured with the server URL and other app settings.

## Development and Making Contributions

Our [developer guide](https://developers.mattermost.com/contribute/desktop/) has detailed information on how to set up your development environment, develop, and test changes to the Desktop App.