Requirements

You must develop on a Mac.

For Android

  • The mxmobile-android.tar.gz file
  • Target Android devices running Lollipop (5.0) or newer

For iOS

  • The mxmobile-ios.tar.gz file
  • Use Xcode 13.1 or higher
  • Target iOS devices running 13 or newer
  • Target iPadOS devices running 13.1 or newer

Setup

Once you’ve downloaded your tar file from the releases page, run either:

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

Your tar file should uncompress the gzipped tarball 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 these packages:
    2.1. brew install imagemagick
    2.2. brew install cmake
  3. Install RVM.
  4. Install ruby: rvm install ruby-2.7.0.
  5. (Optional) Create the mxmobile gemset: cd . By default, RubyGems are stored in a system location. If you have multiple projects that use RubyGems, the gems may conflict with each other. RVM lets you create a separate folder called a gemset. It then sets up your environment such that the bundler will install the gems into the gemset so that different gemsets don’t conflict with each other nor with the system gems.
  6. Install python3 (3.7.3): brew install python3.
  7. Install pip (which isn’t automatically installed when installing python through Homebrew).
  8. Install conan (1.16.1): pip3 install conan.

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

Once 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 File
1
2
EMAIL=<artifactory_email_from_mx>
PASSWORD=<artifactory_password_from_mx>

If Building on 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 on iOS

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

Report a Bug

If you encounter an issue while using the SDK, please report the bug in the following way:

  1. In your mobile app, select the floating dev tools widget. Then, select the bug icon.

Primary button section in themes file

  1. Fill out the form.

Primary button section in themes file

  1. Press Send.

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 adding your custom assets.