https://github.com/insertkoinio/koin-embedded
Embedded version of Koin via relocation scripts (sources & modules)
https://github.com/insertkoinio/koin-embedded
android embedded koin kotlin kotlin-multiplatform sdk
Last synced: 3 months ago
JSON representation
Embedded version of Koin via relocation scripts (sources & modules)
- Host: GitHub
- URL: https://github.com/insertkoinio/koin-embedded
- Owner: InsertKoinIO
- License: apache-2.0
- Created: 2025-03-24T11:15:10.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-26T17:58:30.000Z (3 months ago)
- Last Synced: 2025-03-26T18:42:33.070Z (3 months ago)
- Topics: android, embedded, koin, kotlin, kotlin-multiplatform, sdk
- Language: Shell
- Homepage: https://insert-koin.io
- Size: 876 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Koin Embedded for Kotlin SDK & Library
This project proposes scripts to help rebuild & package Koin project with a different package name. The interest is for SDK & Library development, to avoid conflict between embedded Koin version and any consuming application that would use another version of Koin, that might conflict.
Feedback or help? Contact [Koin Team](mailto:[email protected]).
# Koin Embedded Version
Here is an example of Koin embeded version: [Kotzilla Repository](https://repository.kotzilla.io/#browse/browse:Koin-Embedded)
- Available packages: `embedded-koin-core`, `embedded-koin-android`
- Relocation on from `org.koin.*` to `embedded.koin.*`
Setupr your Gradle config with this Maven repository:
```kotlin
maven { 'https://repository.kotzilla.io/repository/kotzilla-platform/' }
```
# Koin Relocation Scripts
## Setup
Open `relocate.properties` file to specify:
- RELOCATION_PREFIX - Prefix to relocate Koin package. "embedded", will transform `org.koin.*` to `embedded.koin.*`
- TARGET_KOIN_VERSION - Koin version tag to use
- KOIN_MODULES - list of Koin modules to rename with prefix. I.e `koin-core` will become `embeded-koin-core`
- BUILD_DIR - folder where Koin built artifacts are copied
## Run the Scripts
> Requirements: JDK 17 environment to build Koin project
Just run `./relocate.sh`. The output build will be in `./build` or $BUILD_DIR
## Get the Koin JAR/AAR
Once executed, open the `./build` or $BUILD_DIR folder to get your aar/jar artifacts, to add to your project
# Project Sample
The `embedded-project-sample` folder contains sample for Koin embedded SDK Library.
- sample-library - Android library project, using Koin embedded version in 3.5.6
- sample-app - Android Application using Koin 4.0.2 and sample-library
## Install Library
from `embedded-project-sample/sample-library` run `install.sh`
> This projects uses Kotzilla Koin Embedded repo.
## Run App & Library
from `embedded-project-sample/sample-app`, run the Android app