Overview
Are you ready to take your mobile app development to the next level? With SugarCRM's mobile SDK, you can create custom mobile apps that integrate seamlessly with the SugarCRM platform. This quick start guide will walk you through the process of installing and setting up the SDK, as well as provide a sample project to get you started.
Features
The SugarCRM mobile SDK is built on top of standard web technologies like HTML5, CSS3/Less, and JavaScript, making it easy to customize with your own UI elements and business logic. The SDK code base has been stripped of Sugar-specific configuration and branding elements, allowing you to focus on building a custom app that meets your unique needs.
The SDK also includes a public API that allows for the rendering of various UI components, including:
- Custom fields
- Custom views
- Custom dashlets
- Custom record actions
- Custom menu items
- Integration with custom Apache Cordova plugins
Limitations
When extending the core mobile product using the SugarCRM mobile SDK, it's essential to stay within the boundaries of the public API. Modifying the SDK code base or making unsupported customizations can lead to compatibility issues and make it difficult to upgrade your app in the future.
Additionally, the SugarCRM mobile app and a custom app built using the SDK cannot be installed on the same device. It's also important to note that while you may be able to customize native code via integration with Cordova plugins, directly editing the contents of your native folder is not recommended and will not be supported by SugarCRM.
Prerequisites
To access the SugarCRM mobile SDK, you must be in one of the following authorized user groups:
- Customers running a supported version of Sugar Enterprise, Enterprise+, Serve, Sell Advanced, or Sell Premier
- SugarCRM's OEM partners for use and distribution with their authorized OEM solution
- Partners of eligible customers
You should also be proficient in standard web technologies like HTML5, CSS3/Less, and JavaScript, as well as Handlebars.js templating engine. For iOS apps, you'll need to be familiar with Xcode, Objective-C, and the iOS SDK (optional). For Android apps, you'll need Java and the Android SDK (optional).
Software Requirements
Before installing the SDK, please confirm that your development machine meets the following software requirements:
- Chrome or Safari desktop browser
- Node Version Manager (NVM) with the correct version of node.js installed
- Homebrew Package Manager
- Yarn package manager installed using Homebrew
You may also want to be familiar with platform-specific technologies like Xcode for iOS native apps and Android Studio and Android SDK.
Installation
The SugarCRM mobile SDK is distributed as a .zip package that includes the SDK source code, a README file with installation instructions, and a shell script that installs the SDK and generates an empty custom mobile app project. To install the SDK, follow these steps:
- Log in to https://mobiletools.sugarcrm.com with your sugarcrm.com username and password.
- Select "Mobile SDK" from the dropdown at the top of the page.
- Click on the Download button to save the latest SDK package to your local system.
- Unpack the .zip contents into a temporary folder.
- Declare the SUGAR_MOBILE_SDK_HOME environment variable in your shell profile script.
- In addition, declare environment variables that point to your Android SDK installation and Android SDK tools.
By following these steps and using the SugarCRM mobile SDK, you'll be able to create custom mobile apps that integrate seamlessly with the SugarCRM platform.