If you haven’t set up your developer environment, please do so before continuing with this section.
Here’s a general workflow for a Mattermost developer working on the mattermost-webapp repository:
$NUMBERis the Jira ticket number you are working on and
$DESCRIPTIONis a short description of your changes. Example branch names are
make testto run the unit tests.
make runfrom the root directory of the server repository. This will start up the server and a watcher process that will build any changes to the client as you make them. To get changes to the server it must be restarted with
make restart-server. Your server will be running at
make i18n-extractto generate the new/updated strings.
make stopin the server repository, then run
make check-styleto check your syntax and
make testto run the tests.
During development you may want to reset the database and generate random data for testing your changes. For this purpose, Mattermost has the following commands in the mattermost CLI:
Install the server with
go install ./cmd/mattermost in the server repository.
You can reset your database to the initial state using:
After that, you can generate random data to populate the Mattermost database using: