Mattermost Logo
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 dependencies:

  3. Fork https://github.com/mattermost/mattermost-webapp

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

    git clone https://github.com/$GITHUB_USERNAME/mattermost-webapp.git
    
  5. Link the client directory in your server with the dist directory in your webapp:

    cd mattermost-server
    ln -nfs ../mattermost-webapp/dist client
    cd ..
    
  6. Test your environment:

    cd mattermost-webapp
    make test
    
  7. 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