Overview

This guide takes you through the SDK’s setup process. At the end of this guide, you’ll be able to run a default build of our mobile app.

Requirements

For Android

  • The mxmobile-android.tar.gz file.
  • Develop on a Mac running macOS 11.3 or higher.
  • Target Android devices running Lollipop (5.0) or higher.

For iOS

  • The mxmobile-ios.tar.gz file.
  • Develop on a Mac running macOS 11.3 or higher.
  • Use Xcode 13.1 or higher.
  • Target iOS devices running 13 or higher.
  • Target iPadOS devices running 13.1 or higher.

Setup

After downloading your tar file from the Releases Page, run either:

  • tar -xvf mxmobile-ios.tar.gz
  • tar -xvf mxmobile-android.tar.gz

tar will uncompress the file and create a folder in the same directory with the name mxmobile-ios or mxmobile-android.

Open your mxmobile-ios or mxmobile-android folder, then:

  1. Install Homebrew. Run brew update to make sure you have the most recent version.
  2. Install imagemagick and cmake:
    • brew install imagemagick
    • brew install cmake
  3. Install RVM.
  4. Install ruby: rvm install ruby-2.7.0.
  5. After installing and initializing RVM in your terminal emulator, cd into mxmobile-ios or mxmobile-android. If you haven’t already installed Ruby 2.7.0, you will see a message like “Required ruby-2.7.0 is not installed.” Run rvm install 2.7.0 to install Ruby 2.7.0. After you install Ruby, run cd . to create the MXmobile RVM gemset. Verify that the gemset was created by running rvm gemset list. You should see output similar to the following:

Output

1
2
3
4

gemsets for ruby-2.7.0 (found in /Users/<you>/.rvm/gems/ruby-2.7.0)
   (default)
   global
=> mxmobile"
  1. Install python3: brew install python3.
  2. Ensure pip is installed.
  3. Install conan: pip3 install conan.
  4. Run conan remote remove conancenter. This removes the default remote that conan may have set up, which conflicts with the MX conan remote.

Now, contact MX to obtain an Artifactory email and password.

After you’ve received your Artifactory email and password, create a text file in the root of your mxmobile-android or mxmobile-ios directory called artifactory.txt and add the artifactory credentials MX provided:

artifactory.txt
1
2

EMAIL=<artifactory_email_from_mx>
PASSWORD=<artifactory_password_from_mx>

If Building for Android

  1. Run ./setup armv8 (or armv7, x86_64).
  2. Run ./generate.
  3. Open Android Studio.
  4. Select File > Open….
  5. Open the proj.android folder.
  6. Wait for gradle to finish syncing the project, then build.

If Building for iOS

  1. Run ./setup.
  2. Run ./generate.
  3. Open proj.apple/mxmobile.xcodeproj.
  4. Run build MXmobile iOS scheme onto a test device or Simulator.

Configure

If you change any configuration files, you’ll need to run ./generate before building again.

Report SDK Issue

If you encounter an issue following any of the instructions in the MXmobile SDK documentation, please fill out an issue on the SDK’s GitHub page.

Important Files

The MXmobile SDK provides many important files that you can edit to change your mobile app’s visuals and functionality.

For a complete list of important files, please visit the files overview in the reference.

Next Steps

Customize the App

Now that you’ve installed the MXmobile SDK, it is yours to control. We recommend you start making the app your own by applying your own branding.

Apply Branding