ResearchKit wrapper for Kinvey
Swift Other
Latest commit 130f1ab Jan 24, 2017 @heyzooi heyzooi committed on GitHub Merge pull request #3 from Kinvey/MLIBZ-1633_task_ids
Map task IDs to their own property
Permalink
Failed to load latest commit information.
Carthage/Build Travis CI integration Jan 6, 2017
KinveyResearchKit.xcodeproj
KinveyResearchKit.xcworkspace
KinveyResearchKit
KinveyResearchKitTests
Samples/ORKCatalog
.gitignore
.travis.yml
CONTRIBUTING.md
Cartfile
Cartfile.resolved
LICENSE
Makefile Travis CI integration Jan 6, 2017
README.md

README.md

kinvey-researchkit

ResearchKit wrapper for Kinvey

The kinvey-researchkit package can be used to develop ResearchKit applications on the Kinvey platform. It wraps the Kinvey iOS SDK with classes that allow easy mapping of ResearchKit objects to a Kinvey backend.

Please refer to the Kinvey DevCenter for documentation on using Kinvey.

Prerequisites

  • iOS 9 or later
  • XCode 8.1 or above, Swift 2.3 or Swift 3
  • Kinvey app ID and secret. If you have not created a Kinvey app yet, create one here.

Getting Started

  • Open KinveyResearchKit.workspace. The workspace contains two projects:

    • KinveyResearchKit - is a wrapper SDK that exposes classes to back ResearchKit objects with a Kinvey backend.
    • ORKCatalog - is a fork of the ResearchKit sample, that shows how to use KinveyResearchKit in your app.
  • Replace myAppKey and myAppSecret in the AppDelegate of ORKCatalog with values you obtain from Kinvey.

  • Run ORKCatalog.

  • Before run other operations, run either Account Creation or Login (inside Onboarding section) in order to have an active user which allows you to save data in Kinvey's backend

How to use

We made the following changes to the ORKCatalog sample. To use the SDK in your own project, you will need to make similar changes -

  • Add framework dependencies to Kinvey and KinveyResearchKit
  • Add code in the AppDelegate to initialize Kinvey and login with user (refer to the Getting Started guide for details)
  • For every ORKResult, setting the ResultViewController.result property also saves the result to Kinvey (refer to the Data Store guide for details on how to save data to Kinvey)

License

See LICENSE for details.

Contributing

We like to see contributions from the community! If you see a bug, want to add a new capability, or just want to give us feedback, we'd love to hear from you. See CONTRIBUTING.md for details on reporting bugs and making contributions.