Yorkie Android SDK

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

How to use

See Getting Started with Android SDK for the instructions.

Example projects can be found in the examples folder.

Read the full documentation for all details.

Developing the SDK

To work on this project, make sure you have Android Studio version Hedgehog | 2023.1.1 or later installed.

For developers with MAC, you should add protoc_platform=osx-x86_64 to your local.properties.

Testing yorkie-android-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.

$ ./gradlew 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

Contributing

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

Contributors ✨

Thanks goes to these incredible people: