Telerik AppBuilder for Sublime Text

Build and test iOS, Android and Windows Phone hybrid apps using a single pure HTML5, CSS, and JavaScript code base

Leverage the build and test capabilities of Telerik AppBuilder from Sublime Text 2 or Sublime Text 3

This package lets you run your hybrid mobile app on connected devices or in the device simulator, and synchronize your code changes to the running app without redeploying it. The package requires that the Telerik AppBuilder Command-Line Interface is installed on your system.

The Telerik AppBuilder Command-Line Interface is delivered for Windows, OS X, and Linux as an npm package. For more information click here.

• Installation
• Usage
• Contribution
• More Telerik AppBuilder Tools and Resources
• License

Installation

Latest version: Telerik AppBuilder 2.8
Release date: 2015, February 16

For a complete list of the features available in Telerik AppBuilder 2.8, see Telerik AppBuilder 2.8 Release Notes.

Software Requirements

• Windows, OS X Mavericks, or Linux
• Sublime Text 2 or Sublime Text 3
• Package Control for your version of Sublime Text
• Telerik AppBuilder Command-Line Interface
  Your version of the Telerik AppBuilder package for Sublime Text must match the latest official major release of the Telerik AppBuilder Command-Line Interface.
• Any software required by the Telerik AppBuilder Command-Line Interface

Install the Package

Install this package with Package Control.

• Install the AppBuilder Package for Sublime Text on Windows
• Install the AppBuilder Package for Sublime Text on OS X
• Install the AppBuilder Package for Sublime Text on Linux

Install the AppBuilder package for Sublime Text on Windows

1. Run Sublime Text.
2. Select Preferences → Package Control.
3. Select Install Package.
4. Start typing Telerik AppBuilder and select the package from the list.
5. Wait for the installation to complete.

Install the AppBuilder package for Sublime Text on OS X

1. Run Sublime Text.
2. Select Sublime Text → Preferences → Package Control.
3. Select Install Package.
4. Start typing Telerik AppBuilder and select the package from the list.
5. Wait for the installation to complete.

If Sublime Text cannot load the package properly, verify that the path variables for Node.js and AppBuilder are populated properly in telerik_appbuilder.sublime-settings.

1. In the terminal, run the following command.

   which node
   

2. In the terminal, run the following command.

   which appbuilder
   

3. Select Sublime Text → Preferences → Package Control.

4. Locate and open the Telerik AppBuilder folder.

5. Open telerik_appbuilder.sublime-settings and replace the declared path values.

   {
       "node_osx_path": "The path retrieved in Step 1"
       "appbuilder_osx_path": "The path retrieved in Step 2"
   }
   

6. Save changes.

7. Restart Sublime Text.

Install the AppBuilder package for Sublime Text on Linux

IMPORTANT: If you used sudo apt-get install to install Node.js, make sure that you have installed the nodejs-legacy package instead of node.

1. Run Sublime Text.
2. Select Sublime Text → Preferences → Package Control.
3. Select Install Package.
4. Start typing Telerik AppBuilder and select the package from the list.
5. Wait for the installation to complete.

If Sublime Text cannot load the package properly, verify that the path variables for Node.js and AppBuilder are populated properly in telerik_appbuilder.sublime-settings.

1. In the terminal, run the following command.

   which node
   

2. In the terminal, run the following command.

   which appbuilder
   

3. Select Sublime Text → Preferences → Package Control.

4. Locate and open the Telerik AppBuilder folder.

5. Open telerik_appbuilder.sublime-settings and replace the declared path values.

   {
       "linux_node_path": "The path retrieved in Step 1"
       "linux_appbuilder_path": "The path retrieved in Step 2"
   }
   

6. Save changes.

7. Restart Sublime Text.

The Telerik AppBuilder menu becomes available under the Tools menu.

Back to Top

Usage

After you install this package, you can access the available build and sync commands from Tools -> Telerik AppBuilder.

• Run on Device
• Configure LiveSync
• Reload the App on Device
• Run in the Device Simulator

Run on Device

You can build and deploy your app on one device at a time with the Tools -> Telerik AppBuilder -> Build and Deploy operation.

In this version of the AppBuilder package for Sublime Text for Linux, you cannot build and deploy your app via cable connection on iOS devices.

To be able to work with connected iOS devices on Windows systems, verify that you have downloaded and installed the 32-bit Node.js.

1. Connect your devices.
2. Select Tools -> Telerik AppBuilder -> Build and Deploy.
   If you have connected multiple devices, Sublime Text will display a drop-down list of the connected devices with their unique identifiers and mobile platform.
3. If prompted, select the device on which you want to deploy.
4. Track the deployment process in the status bar and in the log.
5. After the deployment completes, run your app on device.

Configure LiveSync

You can toggle real-time synchronization of your code changes on save with the Tools -> Telerik AppBuilder -> LiveSync on Save option.

When you modify your code and save your changes, your running app will refresh automatically if the device is connected to your system. This operation replaces only the modified application files.

1. Select Tools -> Telerik AppBuilder -> Enable LiveSync on Save.
   A check mark indicates that LiveSync is enabled.
2. On your connected devices or in the device simulator, run your app.
3. Modify your code and save changes.

The app refreshes automatically.

Reload the App on Device

You can synchronize all your changes to an app deployed on a connected device at once with the Tools -> Telerik AppBuilder -> LiveSync Application operation. This operation replaces all application files at once.

In this version of the AppBuilder package for Sublime Text for Linux, you cannot LiveSync your app via cable connection on iOS devices.

To be able to work with connected iOS devices on Windows systems, verify that you have downloaded and installed the 32-bit Node.js.

1. Verify that you have connected your device and you have deployed the app.
2. Run your app.
3. Modify your code and save changes.
4. Select Tools -> Telerik AppBuilder -> LiveSync Application.
   If you have connected multiple devices, Sublime Text will display a drop-down list of the connected devices with their unique identifiers and mobile platform.
5. Select the device to which you want to sync changes.
6. Track the deployment process in the status bar and in the log.

Run in the Device Simulator

You can build and deploy your app in the device simulator with the Tools -> Telerik AppBuilder -> Run in Simulator operation.

In this version of the AppBuilder package for Sublime Text for Linux, you cannot run your app in the device simulator.

• Select Tools -> Telerik AppBuilder -> Run in Simulator.

In the device simulator, you can change the target device form factor, mobile platform and version, and orientation. You can adjust the geolocation details, network connection configuration, file storage configuration, and the default contacts. You can debug your code using the built-in debug tools.

Back to Top

Contribution

To learn how to log a bug that you just discovered, click here.

To learn how to suggest a new feature or improvement, click here.

To learn how to contribute to the code base, click here.

Back to Top

More Telerik AppBuilder Tools and Resources

• Telerik AppBuilder Windows client: Lightweight Windows IDE.
• Telerik AppBuilder in-browser client: Browser-based IDE that is compatible with most modern web and mobile browsers.
• Telerik AppBuilder extension for Visual Studio: Extension for the popular Microsoft IDE.
• Telerik AppBuilder command-line interface: A command-line interface that lets you leverage the cloud capabilities of Telerik AppBuilder from the command line.
• Telerik AppBuilder companion app: iOS, Android and Windows Phone testing utility available for free on the App Store.
• Telerik AppBuilder documentation: Learn more about what you can do with Telerik AppBuilder.
• Telerik AppBuilder web page: Visit the Telerik AppBuilder web site.

Back to Top

License

This software is licensed under the Apache 2.0 license, quoted here.

Back to Top