First, clone down this project, and then from within that directory in your favorite terminal run:
> npm install // installs packages.... > npm link // creates a local symlink
You're now ready to start developing against your local mattermost installation. Make sure
you have your
config.json setup as noted in the steps below.
Connecting to your team
For now, Matterfront is limited to one team connection. The url for your team is pulled from a json file in your home directory.
Create a text file at
~ is your home directory). Make it look like this:
You should be able to provide your credentials when Matterfront starts up.
Support for adding multiple teams through the UI is coming soon.
This project contains a Vagrant environment, consisting of a locally hostable mattermost instance you can use for testing. Alternatively, you can use your own production mattermost server.
Use your production Mattermost instance
After following the configuration steps above, run
npm start from within your matterfront directory
- Set up your
vagrant upfrom within your local copy of this repo
Building your own app
First follow the install instructions above. Then from within your project root, you can build for all platforms and distributions by running:
npm run build
This will output the following distributions into the
dist/ |- matterfront-darwin-x64/ |- matterfront-linux-ia32/ |- matterfront-linux-x64/ |- matterfront-win32-ia32/ |- matterfront-win32-x64/
Each directory contains an executable for the platform listed. For more detailed
build options, check out how to modify your
build from within
using the options from electron-packager to modify your built artifacts.
If you are on Linux or OS X, you need Wine for Windows builds.
Name and affiliation
Matterfront is a Mattermost frontend application. This application is in no way affiliated with nor endorsed by Mattermost. See Mattermost branding guidelines.