platform-deliveries-hybrid/README.md

Telerik Deliveries Sample App for PhoneGap/Cordova

• Overview
• Requirements
• Configuration
• Running the Sample
• Testing the Sample

Overview

This repository contains the Telerik Deliveries app for PhoneGap/Cordova. It is a sample mobile app demonstrating how to integrate and use the Offline Support and Caching features provided by the Telerik Platform Backend Services JavaScript SDK.

The detailed list of showcased features includes:

• Offline Support
  • Switching between online and offline mode
  • Data synchronization
  • ClientWins conflict resolution strategy
  • Offline files
  • UI integration
• Caching
• Authentication Persistence

Similarly to all other Telerik Platform hybrid apps, Telerik Deliveries runs on iOS, Android, and Windows Phone 8.

Screenshots

Login Screen	Main Menu	All Orders, Offline

Requirements

Before you begin, you need to ensure that you have the following:

• An active Telerik Platform account Ensure that you can log in to a Telerik Platform account. This can be a free trial account. Depending on your license you may not be able to use all app features. For more information on what is included in the different editions, check out the pricing page. All features included in the sample app work during the free trial period.

• Telerik AppBuilder The sample app requires Telerik AppBuilder to run. This can be the in-browser client, the desktop client or the extension for Visual Studio.

Configuration

The Deliveries sample app comes fully functional, but to see it in action you must link it to a Telerik Platform app.

1. Click the Run in the Platform button to clone the repository in Telerik Platform.
   A new Telerik Platform app is created for you. You can view the app source code on the Code tab.
2. Click the Data tab and then click Enable Data.
3. Click the Settings tab.
4. Take note of your App ID and API Master Key.
5. Go back to Code.
6. Open the config.js file.
7. Set the Config.AppId value to the App ID that you acquired earlier.
8. Set the Config.MasterKey value to the API Master Key that you acquired earlier.

Running the Sample

Once the app is configured, you can run it either on a real device or in the Telerik Platform simulator.

To run it, follow the steps in the product's documentation: Running Apps on Devices.

After you run the app successfully, it guides you through a data initialization process which builds the necessary data structure in your Telerik Platform app and then creates sample data.

Testing the Sample

For your convenience, the app always displays whether it works online or offline. You can simulate lack of Internet connection from the Telerik Platform simulator. If you are testing on a device, you have to turn off the WiFi and the data connection to go in offline mode.

Ensure that the emulator or the device that you are using has Internet connectivity when running the sample.

One way to test the app is to follow this work flow:

1. Make sure the Internet connection is on.
2. Log in and browse the delivery orders.
3. Turn off the Internet connection and restart the application.
   Result: you can still browse the delivery orders.
4. Change an existing item (enter comment or change status).
5. Turn on the Internet connection.
   Result: Your change is synchronized to the cloud and you can see it in the Telerik Platform portal.