To use the MXmobile SDK, you must develop on a Mac running macOS 11.3 or higher.
- Target Android devices running Lollipop (5.0) or higher.
- Use Xcode 13.1 or higher.
- Target iOS devices running 13 or higher.
- Target iPadOS devices running 13.1 or higher.
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-android folder, then:
- Install Homebrew. Run
brew updateto make sure you have the most recent version.
- Install imagemagick and cmake:
brew install imagemagick
brew install cmake
- Install RVM.
- Install ruby:
rvm install ruby-2.7.0.
- After installing and initializing RVM in your terminal emulator,
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.0to 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:
1 2 3 4 gemsets for ruby-2.7.0 (found in /Users/<you>/.rvm/gems/ruby-2.7.0) (default) global => mxmobile"
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:
1 2 EMAIL=<artifactory_email_from_mx> PASSWORD=<artifactory_password_from_mx>
If Building for Android
- Open Android Studio.
- Select File > Open….
- Open the
- Wait for gradle to finish syncing the project, then build.
If Building for iOS
- Run build MXmobile iOS scheme onto a test device or Simulator.
If you change any configuration files, you’ll need to run
./generate before building again.
If you encounter an issue following any of the instructions in the MXmobile SDK documentation, please fill out an issue on the MXmobile SDK GitHub page.
Otherwise, please report any issues using the developer tools:
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.
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.