Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/aartikov/Sesame

Android architecture components made right
https://github.com/aartikov/Sesame

android architecture coroutines mvi mvvm navigation pagination property reactive-programming

Last synced: about 2 months ago
JSON representation

Android architecture components made right

Host: GitHub
URL: https://github.com/aartikov/Sesame
Owner: aartikov
License: mit
Created: 2020-09-01T14:35:20.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2022-04-22T12:56:55.000Z (over 2 years ago)
Last Synced: 2024-07-11T14:42:44.850Z (3 months ago)
Topics: android, architecture, coroutines, mvi, mvvm, navigation, pagination, property, reactive-programming
Language: Kotlin
Homepage:
Size: 760 KB
Stars: 109
Watchers: 5
Forks: 9
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-list - aartikov/Sesame - Android architecture components made right (Kotlin)

README

# Sesame
[![Maven Central](https://img.shields.io/maven-central/v/com.github.aartikov/sesame-property)](https://repo1.maven.org/maven2/com/github/aartikov/sesame-property/)
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

Sesame is a set of architecture components for Android development. It is based on modern technologies including coroutines and Flow. Sesame is simple to learn and easy to use. It is ideally suited for MVVM and MVI architectures.

Some Sesame features are inspired by [RxPM](https://github.com/dmdevgo/RxPM) library.

## Components
[property](https://github.com/aartikov/Sesame/tree/master/sesame-property) - provides observable properties and one-time commands.
[dialog](https://github.com/aartikov/Sesame/tree/master/sesame-dialog) - allows to control dialogs from View Models.
[navigation](https://github.com/aartikov/Sesame/tree/master/sesame-navigation) - gives an universal way to navigate between screens.
[activable](https://github.com/aartikov/Sesame/tree/master/sesame-activable) - equips View Models with a very simple lifecycle.
[loading](https://github.com/aartikov/Sesame/tree/master/sesame-loading) - helps to manage state for data loading (including paged one).
[loop](https://github.com/aartikov/Sesame/tree/master/sesame-loop) - provides a simple MVI implementation.
[localized string](https://github.com/aartikov/Sesame/tree/master/sesame-localized-string) - helps to deal with string resources.
[form](https://github.com/aartikov/Sesame/tree/master/sesame-form) - provides input field validation.
[compose-form](https://github.com/aartikov/Sesame/tree/master/sesame-compose-form) - same as [form](https://github.com/aartikov/Sesame/tree/master/sesame-form) but for Jetpack Compose.

Sesame components are separate modules. Use only that you like.

## Gradle Setup
```gradle
dependencies {
implementation 'com.github.aartikov:sesame-property:1.5.0'
implementation 'com.github.aartikov:sesame-dialog:1.5.0'
implementation 'com.github.aartikov:sesame-navigation:1.5.0'
implementation 'com.github.aartikov:sesame-activable:1.5.0'
implementation 'com.github.aartikov:sesame-loading:1.5.0'
implementation 'com.github.aartikov:sesame-loop:1.5.0'
implementation 'com.github.aartikov:sesame-localized-string:1.5.0'
implementation 'com.github.aartikov:sesame-form:1.5.0'
implementation 'com.github.aartikov:sesame-compose-form:1.5.0'
}
```

## Sample
[The sample application](https://github.com/aartikov/Sesame/tree/master/sample) consists of several screens. Each screen demonstrates certain Sesame feature.

COUNTER - shows how to use properties and commands from [property](https://github.com/aartikov/Sesame/tree/master/sesame-property).
PROFILE - loads ordinary data with [loading](https://github.com/aartikov/Sesame/tree/master/sesame-loading).
DIALOGS - shows how to use [dialog](https://github.com/aartikov/Sesame/tree/master/sesame-dialog) and [localized string](https://github.com/aartikov/Sesame/tree/master/sesame-localized-string).
MOVIES - loads paged data with [loading](https://github.com/aartikov/Sesame/tree/master/sesame-loading).
CLOCK - shows how to use [activable](https://github.com/aartikov/Sesame/tree/master/sesame-activable).
FORM - validates input fields with [form](https://github.com/aartikov/Sesame/tree/master/sesame-form).
The whole app - demonstrates [navigation](https://github.com/aartikov/Sesame/tree/master/sesame-navigation).

There is no sample for [loop](https://github.com/aartikov/Sesame/tree/master/sesame-loop). See [LoadingLoop](https://github.com/aartikov/Sesame/blob/master/sesame-loading/src/main/kotlin/me/aartikov/sesame/loading/simple/internal/LoadingLoop.kt) and [PagedLoadingLoop](https://github.com/aartikov/Sesame/blob/master/sesame-loading/src/main/kotlin/me/aartikov/sesame/loading/paged/internal/PagedLoadingLoop.kt) as good examples how to use it.

## Compose Sample
[The compose sample](https://github.com/aartikov/Sesame/tree/master/compose-sample) shows how to use Sesame with Jetpack Compose and [Decompose](https://github.com/arkivanov/Decompose). Each screen demonstrates certain Sesame feature.

COUNTER - shows that we don't need [property](https://github.com/aartikov/Sesame/tree/master/sesame-property) to manage Jetpack Compose state. `mutableStateOf` and `derivedStateOf` are used instead.
PROFILE - loads ordinary data with [loading](https://github.com/aartikov/Sesame/tree/master/sesame-loading).
DIALOGS - shows how to use [dialog](https://github.com/aartikov/Sesame/tree/master/sesame-dialog) and [localized string](https://github.com/aartikov/Sesame/tree/master/sesame-localized-string).
MOVIES - loads paged data with [loading](https://github.com/aartikov/Sesame/tree/master/sesame-loading).
FORM - validates input fields with [compose-form](https://github.com/aartikov/Sesame/tree/master/sesame-compose-form).

## Contact the author
Artur Artikov [email protected]

## License
```
The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```