README.md

Core

Docs

Each version has it's docs , you can check the latest docs by providing the latest <version> to the follwoing url https://telereso.github.io/kmp-core/docs/core/<version>/index.html

The latest version is

For example to get docs for version 0.0.4 you can visiting

https://telereso.github.io/kmp-core/docs/core/0.0.4/index.html

Setup

The following are the first commands to init all the project examples

Android

Click run androidApp will open the android example

iOS

Run the following command

cd iosApp && pod install && cd ..

Then Open iosApp in Xcode or AppScript, and click run button will open ios example

Web

Run the following command

cd webApp && yarn && yarn serve

Then open webApp in intellij Idea or VSCode and check README.md file

ReactNative

Run the following command

cd react-native-core-client && yarn && yarn bootstrap && yarn example android && yarn example ios

then open react-native-core-client in intellij Idea or VSCode and check README.md file

Unit Test

All Tetes

./gradlew allTests 

iOS

./gradlew iosSimulatorArm64Test 

Coverage

./gradlew koverHtmlReport 

For more details about contributing check CONTRIBUTING page

Website

Serve

cd website && bundle exec jekyll serve website && cd ..

Publish

The pipeline will take care of publishing the library when merging to main

Locally

to publish to local maven run this command

bash scripts/publish.sh 0.0.13

The output version will be 0.0.13-local and you can use it like this

dependencies {
    api("io.telereso.kmp:core:0.0.13-local")
}