https://github.com/yorkie-team/yorkie-android-sdk
Yorkie Android SDK
https://github.com/yorkie-team/yorkie-android-sdk
android crdt hack hacktoberfest kotlin realtime-collaboration yorkie
Last synced: 5 months ago
JSON representation
Yorkie Android SDK
- Host: GitHub
- URL: https://github.com/yorkie-team/yorkie-android-sdk
- Owner: yorkie-team
- License: apache-2.0
- Created: 2022-07-28T07:09:56.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-14T02:14:29.000Z (5 months ago)
- Last Synced: 2025-05-14T03:53:21.241Z (5 months ago)
- Topics: android, crdt, hack, hacktoberfest, kotlin, realtime-collaboration, yorkie
- Language: Kotlin
- Homepage: https://yorkie.dev/docs/android-sdk
- Size: 4.11 MB
- Stars: 8
- Watchers: 5
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Yorkie Android SDK
[](https://codecov.io/gh/yorkie-team/yorkie-android-sdk)
[](https://search.maven.org/search?q=g:%22dev.yorkie%22%20AND%20a:%22yorkie-android%22)
Yorkie Android SDK provides a suite of tools for building real-time collaborative applications.
## How to use
See [Getting Started with Android SDK](https://yorkie.dev/docs/getting-started/with-android-sdk) for the instructions.
Example projects can be found in the [examples](https://github.com/yorkie-team/yorkie-android-sdk/tree/main/examples) folder.
Read the [full documentation](https://yorkie.dev/docs) 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.
```bash
$ docker compose -f docker/docker-compose.yml up --build -d
```
Start the test in another terminal session.
```bash
$ ./gradlew 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
```
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
## Contributors ✨
Thanks goes to these incredible people:
