Mattermost Logo
Edit on GitHub

Developer Setup

The following instructions apply to the mobile apps for iOS and Android built in React Native. Download the iOS version here and the Android version here. Source code can be found at https://github.com/mattermost/mattermost-mobile.

If you run into any issues getting your environment set up, check the Troubleshooting section at the bottom for common solutions.

A macOS computer is required to build the Mattermost iOS mobile app.

Environment Setup 

iOS and Android 

Install the following prerequisite software to develop and build the iOS or Android apps. For macOS, we recommend using Homebrew as a package manager.

Install NodeJS

This includes NPM which is also needed. Currently version 10.11.0 is recommended with npm 6.4.1. 11.x is not working.

MacOS 
  • To install using Homebrew open a terminal and execute ..
    $ brew install node
  • Install using NVM by following the instructions here
  • Download and install the package from the NodeJS website

    Linux 
  • Install using your distributions package manager (Note that different distros provide different node versions which might be lower than 9.3.0 and may cause problems)

  • Install using NVM by following the instructions here

  • Download and install the package from the NodeJS website

Install Watchman. (minimum required version is 4.9.0) 

MacOS 
  • To install using Homebrew open a terminal and execute ..

    $ brew install watchman
    Linux 
  • On Linux you have to build Watchman yourself. See the official Watchman guide.

    • Note that you need to increase your inotify limits for watchman to work properly
    • If you encounter a warning about a missing C++ compiler you need to install the c++ extension from you distros package manager (Ubuntu: g++, RHEL/Fedora: gcc-g++)

Install react-native-cli tools 

Use npm to install React Native CLI Tools globally (minimum required version is 2.0.1)

$ npm -g install react-native-cli

Obtaining the source code 

We use GitHub to host the source code so we recommend that you install Git to get the source code. Optionally, you can also contribute by submitting pull requests. If you do not have git installed you can do so with Homebrew by opening a terminal and executing:

MacOS 
$ brew install git
Linux 

Some distributions come with git preinstalled but you’ll most likely have to install it yourself. For most distributions the package is simply called git

Additional setup for iOS 

  1. Install Xcode to build and run the app on iOS. (minimum required version is 9.0)
  2. Install Cocoapods using the gem method. You\’ll need it to install the project’s iOS dependencies. (required version is 1.3.1)

Additional setup for Android 

Download and install Android Studio or the Android SDK command line tools

Environment Variables 

Make sure you have the following ENV VARS configured: - ANDROID_HOME to where Android SDK is located (likely /Users/<username>/Library/Android/sdk or /home/<username>/Android/Sdk) - Make sure your PATH includes ANDROID_HOME/tools and ANDROID_HOME/platform-tools

MacOS 
  • On Mac, this usually requires adding the following lines to your ~/.bash_profile file:

    export ANDROID_HOME=$HOME/Library/Android/sdk
    export PATH=$ANDROID_HOME/emulator:$ANDROID_HOME/platform-tools:$ANDROID_HOME/tools:$PATH
  • Then reload your bash configuration:

    source ~/.bash_profile
    Linux 
  • On Linux the home folder is located under /home/<username> which results in a slightly different path

    export ANDROID_HOME=/home/<username>/Android/Sdk
    export PATH=$ANDROID_HOME/platform-tools:$PATH
    export PATH=$ANDROID_HOME/tools:$PATH
  • Then also relead you configuration

    source ~/.bash_profile
    • Note that depending on the shell your using this might need to be put into a different file such as ~/.zshrc. Adjust this accordingly.
    • Also this documentation assumes you chose the default path for your Android SDK installation. If you chose a different path adjust accordingly.

Installing the right SDKs and SDK Tools 

In the SDK Manager using Android Studio or the Android SDK command line tool, ensure the following are installed - SDK Tools (you may have to click “Show Package Details” to expand packages) image - Android SDK Build-Tools (multiple versions) - 23.0.3 - 25.0.3 - 26.0.1 - Android Emulator - Android SDK Platform-Tools - Android SDK Tools - Google Play services - Intel x86 Emulator Accelerator (HAXM installer) - Support Repository - Android Support Repository - Google Repository

- SDK Platforms (you may have to click "Show Package Details" to expand packages)
    ![image](/img/mobile_SDK_Platforms.png)
    - Android 6 (Marshmallow)
        - Google APIs
        - Android SDK Platform 23
        - Intel x86 Atom\_64 System Image
    - Any other API version that you want to test

Obtaining the Source Code 

In order to develop and build the Mattermost mobile apps you’ll need to get a copy of the source code. Forking the mattermost-mobile repository will also make it easy to contribute your work back to the project in the future.

  1. Fork the mattermost-mobile repository on GitHub.

  2. Clone your fork locally:

    • Open a terminal
    • Change to a directory you want to hold your local copy
    • Run git clone https://github.com/<username>/mattermost-mobile.git if you want to use HTTPS, or git clone git@github.com:<username>/mattermost-mobile.git if you want to use SSH

    <username> refers to the username or organization in GitHub that forked the repository

  3. Change the directory to mattermost-mobile.

    cd mattermost-mobile
  4. Run make pre-run in order to install all the dependencies.

Troubleshooting 

Errors When Running ‘make run-android’ 

Error message 
React-native-vector-icons: cannot find dependencies
Solution 

Make sure the Extras > Android Support Repository package is installed with the Android SDK.

Error message 

Execution failed for task ':app:packageAllDebugClassesForMultiDex'.
> java.util.zip.ZipException: duplicate entry: android/support/v7/appcompat/R$anim.class

Solution 

Clean the Android part of the mattermost-mobile project. Issue the following commands:

  1. cd android
  2. ./gradlew clean
Error message 
Execution failed for task ':app:installDebug'.
> com.android.builder.testing.api.DeviceException: com.android.ddmlib.InstallException: Failed to finalize session : INSTALL_FAILED_UPDATE_INCOMPATIBLE: Package com.mattermost.react.native signatures do not match the previously installed version; ignoring!
Solution 

The development version of the Mattermost app cannot be installed alongside a release version. Open android/app/build.gradle and change the applicationId from "com.mattermost.react.native" to a unique string for your app.

Error Message 

[Error] Error: Compilation of µWebSockets has failed and there is no pre-compiled binary available for your system. Please install a supported C++11 compiler and reinstall the module 'uws'.
... looping infinitely ...
Solution 

Your most likely using the wrong version of npm. Recommended is 9.3.0.

Errors When Running ‘make run-ios’ 

Error message 
xcrun: error: unable to find utility "instruments", not a developer tool or in PATH
Solution 
  • Launch XCode and agree to the terms first.
  • Go to Preferences -> Locations and you’ll see an option to select a version of the Command Line Tools. Click the select box and choose any version to use.

  • After this go back to the command line and run make run-ios again.
Error message 
Getting Cocoapods dependencies
/Library/Ruby/Site/2.0.0/rubygems/dependency.rb:315:in `to_specs': Could not find 'cocoapods' (>= 0) among 17 total gem(s) (Gem::LoadError)
Checked in 'GEM_PATH=/Users/<username>/.rvm/gems/ruby-2.4.2:/Users/<username>/.rvm/gems/ruby-2.4.2@global', execute `gem env` for more information
    from /Library/Ruby/Site/2.0.0/rubygems/dependency.rb:324:in `to_spec'
    from /Library/Ruby/Site/2.0.0/rubygems/core_ext/kernel_gem.rb:64:in `gem'
    from /Users/<username>/Software/ruby/bin/pod:22:in `<main>'
make: *** [.podinstall] Error 1
Solution 
  • Install cocoapods with gem install cocoapods
  • If that fails with the below, then reinstall ruby with OpenSSL using rvm reinstall 2.3.0 --with-openssl-dir=/usr/local/opt/openssl and then install cocoapods sh ERROR: While executing gem ... (Gem::Exception) Unable to require openssl, install OpenSSL and rebuild ruby (preferred) or use non-HTTPS sources
  • Run make run-ios again