This repository contains the Friends sample app for PhoneGap/Cordova. The Friends app is a sample mobile app showcasing the integration of Telerik Platform services into a hybrid mobile appllication. To download the source code, just click on the "Download ZIP" button.
Here is a list of the features that are showcased in the Friends sample app:
- Cloud data access (Telerik Backend Services)
- Working with files (Telerik Backend Services)
- User registration and authentication (Telerik Backend Services)
- Authentication with external providers (Facebook, Google, etc.) (Telerik Backend Services)
- Basic app analytics (Telerik Analytics)
- Tracking custom events (Telerik Analytics)
To implement all the features listed above, the sample app utilizes the following Telerik products and SDKs:
- Telerik Backend Services JavaScript SDK - used to work with Telerik Backend Services.
- Enabled Integrated Telerik Analytics Cordova plugin in Telerik AppBuilder.
The following is a list of requirements for the sample app:
-
Active Telerik Platform account
To use this sample app you must have an active Telerik Platform account. Depending on your license you may not be able to use all features of the app. For more information on what is included in the different editions, please check out the pricing page for the respective product. All features included in the sample app will work in the free trial period. -
Telerik AppBuilder
Telerik AppBuilder In-Browser Client, Windows Client or Visual Studio Extension.
The Friends sample app comes fully functional, but to see it in action you must link it to your own Telerik Platform account.
What you need to set:
-
API key for Telerik Backend Services
This links the sample mobile app to a project in Telerik Backend Services. When you activate Telerik Backend Services a Friends sample project is created for you automatically. It has necessary structure defined and some data pre-filled. You must use its API key.
To set the API key open the /scripts/app/settings.js file and replace$EVERLIVE_API_KEY$ with the API Key of your 'Friends' project.
If you happen to break the structure of the automatically generated Friends sample project, you can delete it and a fresh instance will be created again for you automatically. Alternatively, you could create a new project and choose to start from a Friends template, instead of starting from a blank project.
-
[optional] API key for Telerik Analytics
This step is optional, it links the sample mobile app to a Telerik Analytics project in your account. If you do not set this the sample will still work, but no analytics data will collected. -
[optional] Facebook app ID
The sample app allows users to register using their Facebook account. We've pre-initialized the sample to use a Facebook app created by Telerik for the purpose. If you want, you can set it to use your own Facebook application by adjusting the Facebook app ID.
Please replace the default setting in the /scripts/app/settings.js file. -
[optional] Google
The sample app allows users to register using their Google account.
Please replace the default setting in the /scripts/app/settings.js file. -
[optional] Windows Live
The sample app allows users to register using their Live account.
Please replace the default setting in the /scripts/app/settings.js file. -
[optional] Active Directory Federation Services (ADFS)
The sample app allows users to register using ADFS.
Please replace the default setting in the /scripts/app/settings.js file.
Note that ADFS authentication can be done via HTTPS only.
By default the Friends Sample is configured to use HTTP. In case you wish to switch to HTTPS please update the appSettings.everlive.scheme setting in the /scripts/app/settings.js file to "https".
Once the app is configured as described in the previous section, you can run it either on a real device or in the Telerik AppBuilder simulator.
Make sure the emulator or the device you use have working Internet connection when running the sample. Internet connection is necessary in order to connect to the cloud.