aerogear ios sync client
NOTE: The library has been tested with Xcode 6.3
AeroGear iOS Differential Synchronization Client Engine represents a client side implementation for AeroGear Differential Synchronization (DS) Server.
This client uses the communication with the backend server implementation. The iOS SyncEngine performs the actual work of the DiffSync protocol, please refer to its README.md for more details.
Project Info | |
---|---|
License: | Apache License, Version 2.0 |
Build: | CocoaPods |
Documentation: | http://aerogear.org/ios/ |
Issue tracker: | https://issues.jboss.org/browse/AGIOS |
Mailing lists: | aerogear-users (subscribe) |
aerogear-dev (subscribe) |
Build, test and play with aerogear-ios-sync-client
Clone this project
Get the dependencies
The project uses cocoapods 0.36 release for handling its dependencies. As a pre-requisite, install cocoapods and then install the pod. On the root directory of the project run:
bash
pod install
3. open AeroGearSyncClient.xcworkspace
Adding the library to your project
To add the library in your project, you can either use Cocoapods or manual install in your project. See the respective sections below for instructions:
Using Cocoapods
Support for Swift frameworks is supported from CocoaPods-0.36 release upwards. In your Podfile
add:
source 'https://github.com/CocoaPods/Specs.git'
xcodeproj 'YourProjectName.xcodeproj'
platform :ios, '8.0'
use_frameworks!
pod 'AeroGearSyncClient'
pod 'AeroGearSync/JSONPatch'
NOTE: AeroGearSync is using podsubspec, you will need to specify which algorithm option you want to go. For more details, see aerogear-ios-cookbook/Jedi app. and then:
pod install
to install your dependencies.
Manual Installation
Follow these steps to add the library in your Swift project:
- Add AeroGearSyncClient as a submodule in your project. Open a terminal and navigate to your project directory. Then enter:
bash git submodule add https://github.com/aerogear/aerogear-ios-sync-client.git
- Open the
aerogear-ios-sync-client
folder, and drag theAeroGearSyncClient.xcodeproj
into the file navigator in Xcode. - In Xcode select your application target and under the
Targets
heading section, ensure that the ‘iOS Deployment Target’ matches the application target of AeroGearSyncClient.framework (Currently set to 8.0). - Select the
Build Phases
heading section, expand theTarget Dependencies
group and addAeroGearSyncClient.framework
. - Click on the
+
button at the top left of the panel and selectNew Copy Files Phase
. Rename this new phase toCopy Frameworks
, set theDestination
toFrameworks
, and addAeroGearSyncClient.framework
.
Repeat the same instructions for aerogear-ios-sync.
Documentation
For more details about the current release, please consult our documentation.
Development
If you would like to help develop AeroGear you can join our developer’s mailing list, join #aerogear on Freenode, or shout at us on Twitter @aerogears.
Also takes some time and skim the contributor guide
Questions?
Join our user mailing list for any questions or help! We really hope you enjoy app development with AeroGear!
Found a bug?
If you found a bug please create a ticket for us on Jira with some steps to reproduce it.