Skip to content

Latest commit

 

History

History
169 lines (116 loc) · 6.95 KB

README.md

File metadata and controls

169 lines (116 loc) · 6.95 KB
Raw

Parse Platform

Parse SDK for iOS | macOS | watchOS | tvOS

A library that gives you access to the powerful Parse Server backend from your iOS or macOS app.

Follow on Twitter Maintenance help wanted Platforms License Podspec Backers on Open Collective Sponsors on Open Collective

Carthage compatible Dependencies References Build status Build status Coverage status Join the conversation


For more information about the Parse Platform and its features, see the public documentation.

Check out some of the apps using Parse.

Getting Started

To use parse, head on over to the releases page, and download the latest build. And you're off!. Take a look at the public documentation & API and start building.

Notice the API docs aren't totally up to date when it comes to latest Swift signature of the methods and more importantly regarding Push Notifications which are no longer supported by Parse server, keep an eye on its repo

Other Installation Options

CocoaPods

Add the following line to your Podfile:

pod 'Parse'

Run pod install, and you should now have the latest parse release.

If you wish to use the Facebook or Twitter utils or ParseUI, you can now leverage Cocoapods 'subspecs'

pod 'Parse/FacebookUtils'
pod 'Parse/TwitterUtils'
pod 'Parse/UI'

Note that in this case, the Parse framework will contain all headers and classes, so you just have to use:

import Parse
@import Parse;

Carthage

Add the following line to your Cartfile:

github "parse-community/Parse-SDK-iOS-OSX"

Run carthage update, and you should now have the latest version of Parse SDK in your Carthage folder.

This will also compile the ParseTwitterUtils, ParseFacebookUtilsV4 as well as ParseUI frameworks.

Compiling for yourself

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

Using Parse as a 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.

Preparing for a new release

Update the version number

You can use the rake task in order to bump the version number, it's safe, and will properly update all version numbers

$ bundle exec rake package:set_version[X.X.X]

Replace X.X.X by the version number and push to the repository.

Dependencies

We use the following libraries as dependencies inside of Parse:

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

Other Parse Projects

License

Copyright (c) 2015-present, Parse, LLC.
All rights reserved.

This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree. An additional grant
of patent rights can be found in the PATENTS file in the same directory.

As of April 5, 2017, Parse, LLC has transferred this code to the parse-community organization, and will no longer be contributing to or distributing this code.