Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/05nelsonm/component-request

Kotlin Multiplatform library for modularized processing of requests, agnostic of type. A light weight framework that is highly customizable.
https://github.com/05nelsonm/component-request

android android-lib android-libraries android-library android-libs kotlin kotlin-android kotlin-multiplatform kotlin-multiplatform-library kotlin-multiplatform-mobile

Last synced: 3 months ago
JSON representation

Kotlin Multiplatform library for modularized processing of requests, agnostic of type. A light weight framework that is highly customizable.

Awesome Lists containing this project

README

        

# component-request
[![badge-license]][url-license]
[![badge-latest-release]][url-latest-release]

[![badge-kotlin]][url-kotlin]
[![badge-coroutines]][url-coroutines]

![badge-platform-android]
![badge-platform-jvm]
![badge-platform-js]
![badge-platform-js-node]
![badge-platform-linux]
![badge-platform-macos]
![badge-platform-ios]
![badge-platform-tvos]
![badge-platform-watchos]
![badge-platform-windows]
![badge-support-apple-silicon]
![badge-support-js-ir]

Agnostic and modularized framework for facilitating multi-module requests
whereby module decoupling can be maximized. See the sample android project
where it is used for navigation.

A full list of `kotlin-components` projects can be found [HERE](https://kotlin-components.matthewnelson.io)

### Get Started

```kotlin
// build.gradle.kts
dependencies {
val vRequest = "3.0.6"

// `request-feature` will provide `request-concept`
implementation("io.matthewnelson.kotlin-components:request-feature:$vRequest")

// If your project is modularized and/or you only need the abstractions
implementation("io.matthewnelson.kotlin-components:request-concept:$vRequest")

// EXTENSIONS - navigation

// navigation extension (provides `request-concept`)
implementation("io.matthewnelson.kotlin-components:request-extension-navigation:$vRequest")

// alternatively, use the androidx navigation library extension (provides
// `request-extension-navigation`). (android target only)
implementation("io.matthewnelson.kotlin-components:request-extension-navigation-androidx:$vRequest")
}
```

```groovy
// build.gradle
dependencies {
def vRequest = "3.0.6"

// `request-feature` will provide `request-concept`
implementation "io.matthewnelson.kotlin-components:request-feature:$vRequest"

// If your project is modularized and/or you only need the abstractions
implementation "io.matthewnelson.kotlin-components:request-concept:$vRequest"

// EXTENSIONS - navigation

// navigation extension (provides `request-concept`)
implementation "io.matthewnelson.kotlin-components:request-extension-navigation:$vRequest"

// alternatively, use the androidx navigation library extension (provides
// `request-extension-navigation`). (android target only)
implementation "io.matthewnelson.kotlin-components:request-extension-navigation-androidx:$vRequest"
}
```

### Kotlin Version Compatibility

**Note:** as of `3.0.0`, the experimental memory model for Kotlin Native is enabled.

| request | kotlin | kotlinx-coroutines |
|:-------:|:------:|:------------------:|
| 3.0.6 | 1.8.0 | 1.6.4 |
| 3.0.5 | 1.7.20 | 1.6.4 |
| 3.0.4 | 1.6.21 | 1.6.3 |
| 3.0.3 | 1.6.21 | 1.6.1 |
| 3.0.2 | 1.6.21 | 1.6.1 |
| 3.0.1 | 1.6.10 | 1.6.0 |
| 3.0.0 | 1.6.10 | 1.6.0 |
| 2.0.0 | 1.5.31 | 1.5.2 |

### Git

This project utilizes git submodules. You will need to initialize them when
cloning the repository via:

```bash
$ git clone --recursive https://github.com/05nelsonm/component-request.git
```

If you've already cloned the repository, run:
```bash
$ git checkout master
$ git pull
$ git submodule update --init
```

In order to keep submodules updated when pulling the latest code, run:
```bash
$ git pull --recurse-submodules
```

[badge-latest-release]: https://img.shields.io/badge/latest--release-3.0.6-blue.svg?style=flat
[badge-license]: https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat

[badge-kotlin]: https://img.shields.io/badge/kotlin-1.8.0-blue.svg?logo=kotlin
[badge-coroutines]: https://img.shields.io/badge/coroutines-1.6.4-blue.svg?logo=kotlin

[badge-platform-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat
[badge-platform-jvm]: http://img.shields.io/badge/-jvm-DB413D.svg?style=flat
[badge-platform-js]: http://img.shields.io/badge/-js-F8DB5D.svg?style=flat
[badge-platform-js-node]: https://img.shields.io/badge/-nodejs-68a063.svg?style=flat
[badge-platform-linux]: http://img.shields.io/badge/-linux-2D3F6C.svg?style=flat
[badge-platform-macos]: http://img.shields.io/badge/-macos-111111.svg?style=flat
[badge-platform-ios]: http://img.shields.io/badge/-ios-CDCDCD.svg?style=flat
[badge-platform-tvos]: http://img.shields.io/badge/-tvos-808080.svg?style=flat
[badge-platform-watchos]: http://img.shields.io/badge/-watchos-C0C0C0.svg?style=flat
[badge-platform-wasm]: https://img.shields.io/badge/-wasm-624FE8.svg?style=flat
[badge-platform-windows]: http://img.shields.io/badge/-windows-4D76CD.svg?style=flat
[badge-support-android-native]: http://img.shields.io/badge/support-[AndroidNative]-6EDB8D.svg?style=flat
[badge-support-apple-silicon]: http://img.shields.io/badge/support-[AppleSilicon]-43BBFF.svg?style=flat
[badge-support-js-ir]: https://img.shields.io/badge/support-[js--IR]-AAC4E0.svg?style=flat

[url-latest-release]: https://github.com/05nelsonm/component-request/releases/latest
[url-license]: https://www.apache.org/licenses/LICENSE-2.0.txt
[url-kotlin]: https://kotlinlang.org
[url-coroutines]: https://github.com/Kotlin/kotlinx.coroutines