kalium

(β˜… 72)

🍌 An SDK for creating Wire clients on Android and JVM. Expanding to iOS and Web.

Showing a partial file list β€” download the zip above to see everything.

  • .editorconfig
  • .gitattributes
  • .gitignore
  • .pre-commit-config.yaml
  • build.gradle.kts
  • codecov.yml
  • LICENSE
  • Makefile
  • README.md
  • THIRD-PARTY-NOTICE.md

# Installation Guide

1. Get the code
git clone https://github.com/wireapp/kalium

Downloads the entire project code from GitHub to your computer.

cd kalium

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
./gradlew build

Builds the project using Gradle.

./gradlew jvmTest -Djava.library.path=./native/libs

Builds the project using Gradle.

./gradlew detekt

Builds the project using Gradle.

./gradlew <task> -PUSE_UNIFIED_CORE_CRYPTO=true

Builds the project using Gradle.

./gradlew <task> -Pkalium.providerCacheScope=LOCAL

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

3. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation