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

Config connect Yorkie Server

Local

Install Yorkie Server

Using Docker

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

Using CLI

Install Yorkie CLI following guidance.

Note: consider installing version is the same with version of SDK

Start Yorkie server

yorkie server --rpc-addr 0.0.0.0:8080

Config yorkie local server

./scripts/config-yorkie-local-server.sh

Public Cloud

Start and create your project and get API Key on Public Cloud

Config variables in local.properties file with your Yorkie Public Cloud server URL and API key

YORKIE_SERVER_URL=https://api.yorkie.dev
YORKIE_API_KEY=Your Yorkie API key

Self-Hosted Server

If you're running your own Yorkie server, config variables in local.properties file with your server URL and API key

YORKIE_SERVER_URL=https://your-yorkie-server.com
YORKIE_API_KEY=Your Yorkie API key

Contributing

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

Contributors ✨

Thanks goes to these incredible people: