Parse-SDK-iOS-OSX/README.md

4.8 KiB

parse-repository-header-sdk-apple

iOS · iPadOS · macOS · watchOS · tvOS


Build Status CI Build Status Release Snyk Badge Coverage auto-release

SPM

Backers on Open Collective Sponsors on Open Collective License Forum Twitter


A library that gives you access to the powerful Parse Server backend from your iOS, iPadOS, macOS, watchOS and tvOS app. For more information about the Parse Platform and its features, see the public documentation. Check out some of the apps using Parse.


Getting Started

The easiest way to install the SDK is via Swift Package Manager.

  1. Open Xcode > File > Add packages...
  2. Add the following package URL:
https://github.com/parse-community/Parse-SDK-iOS-OSX
  1. Add package
  2. Choose the submodules you want to install

Take a look at the public documentation & API and start building.

Alternative Installation Options

Download Builds

Dowload the compiled builds from the asset section in the releases page.

Compile Source

If you want to manually compile the SDK, clone it locally, and run the following commands in the root directory of the repository:

# To pull in extra dependencies (Bolts and OCMock)
git submodule update --init --recursive

# To install bundler
gem install bundler

# To install all the gems via bundler
bundle install

# Build & Package the Frameworks
bundle exec rake package:frameworks

Compiled frameworks will be in multiple archives inside the build/release folder:

  • Parse-iOS.zip
  • Parse-macOS.zip
  • Parse-tvOS.zip
  • Parse-watchOS.zip
  • ParseFacebookUtils-iOS.zip
  • ParseFacebookUtils-tvOS.zip
  • ParseTwitterUtils-iOS.zip
  • ParseUI.zip

Add Sub-Project

You can also include parse as a subproject inside of your application if you'd prefer, although we do not recommend this, as it will increase your indexing time significantly. To do so, just drag and drop the Parse.xcodeproj file into your workspace. Note that unit tests will be unavailable if you use Parse like this, as OCMock will be unable to be found.

How Do I Contribute?

We want to make contributing to this project as easy and transparent as possible. Please refer to the Contribution Guidelines.

Dependencies

We use the following libraries as dependencies inside of Parse:

  • Bolts, for task management.
  • OCMock, for unit testing.