Mattermost Logo
We're hiring!
Edit on GitHub

Developer Setup

Set up your development environment for building, running, and testing the Mattermost web app.

  1. Set up your development environment for the Mattermost server.

  2. Install Node.js 16:

  3. If necessary, install libpng:

    • On Mac, use Homebrew to install it:

      brew install libpng
    • On Linux-based operating systems, use your preferred package manager to install it.

  4. Fork

  5. Clone the Mattermost source code from your fork next to your mattermost-server directory:

    git clone$GITHUB_USERNAME/mattermost-webapp.git
  6. Link the client directory in your server with the dist directory in your webapp:

    mkdir -p mattermost-webapp/dist
    cd mattermost-server
    ln -nfs ../mattermost-webapp/dist client
    cd ..
  7. Test your environment:

    cd mattermost-webapp
    make test
  8. When tests pass, run the app:

    make run

    Refreshing http://localhost:8065 should now load the UI.

    If you would like the webapp to automatically refresh as you edit the source code you can install and enable the live reload script injection extension for your web browser (Chrome | Firefox). Then, before running webpack run:

    export MM_LIVE_RELOAD=true