Skip to content

yorkie-team/yorkie-ios-sdk

Repository files navigation

Yorkie iOS SDK

Swift Package Manager codecov

Yorkie iOS SDK provides a suite of tools for building real-time collaborative applications.

How to use

See Getting Started with iOS SDK for the instructions.

Example projects can be found in the examples folder.

Read the full documentation for all details.

Testing yorkie-ios-sdk with Envoy, Yorkie and MongoDB.

Start MongoDB, Yorkie and Envoy proxy in a terminal session.

$ docker-compose -f docker/docker-compose.yml up --build -d

Start the test in another terminal session.

$ swift test

To get the latest server locally, run the command below then restart containers again:

$ docker pull yorkieteam/yorkie:latest
$ docker-compose -f docker/docker-compose.yml up --build -d

Testing yorkie-ios-sdk with Homebrew

To test the yorkie-ios-sdk against a locally running Yorkie server installed via Homebrew:

Make sure Homebrew is up to date:

$ brew update

Install the Yorkie server:

$ brew install yorkie

Start the server in your local environment:

$ yorkie server

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

Contributors ✨

Thanks goes to these incredible people: