https://github.com/yorkie-team/yorkie-ios-sdk
Yorkie iOS SDK
https://github.com/yorkie-team/yorkie-ios-sdk
crdt hacktoberfest ios realtime-collaboration swift yorkie
Last synced: 3 months ago
JSON representation
Yorkie iOS SDK
- Host: GitHub
- URL: https://github.com/yorkie-team/yorkie-ios-sdk
- Owner: yorkie-team
- License: apache-2.0
- Created: 2022-07-28T07:09:29.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-06-02T11:18:39.000Z (4 months ago)
- Last Synced: 2025-06-10T13:04:17.941Z (4 months ago)
- Topics: crdt, hacktoberfest, ios, realtime-collaboration, swift, yorkie
- Language: Swift
- Homepage: https://yorkie.dev/docs/ios-sdk
- Size: 19.4 MB
- Stars: 20
- Watchers: 7
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Yorkie iOS SDK
[](https://swiftpackageindex.com/yorkie-team/yorkie-ios-sdk)
[](https://swiftpackageindex.com/yorkie-team/yorkie-ios-sdk)
[](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square)
[](https://codecov.io/gh/yorkie-team/yorkie-ios-sdk)
Yorkie iOS SDK provides a suite of tools for building real-time collaborative applications.
## How to use
See [Getting Started with iOS SDK](https://yorkie.dev/docs/getting-started/with-ios-sdk) for the instructions.
Example projects can be found in the [examples](https://github.com/yorkie-team/yorkie-ios-sdk/tree/main/Examples) folder.
Read the [full documentation](https://yorkie.dev/docs) for all details.
## Testing yorkie-ios-sdk with Envoy, Yorkie and MongoDB.
Start MongoDB, Yorkie and Envoy proxy in a terminal session.
```bash
$ docker-compose -f docker/docker-compose.yml up --build -d
```
Start the test in another terminal session.
```bash
$ swift test
```
To get the latest server locally, run the command below then restart containers again:
```bash
$ 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](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
## Contributors ✨
Thanks goes to these incredible people:
