https://github.com/getspherelabs/cosmo-kmp

Cosmo: Kotlin Multiplatform App using Jetpack Compose and SwiftUI
https://github.com/getspherelabs/cosmo-kmp

combine compose coroutines cosmos jetpackcompose kmm kmp koin kotlin kotlin-multiplatform kotlin-multiplatform-mobile ktor sqldelight swift swiftui

Last synced: 2 months ago
JSON representation

Cosmo: Kotlin Multiplatform App using Jetpack Compose and SwiftUI

• Host: GitHub
• URL: https://github.com/getspherelabs/cosmo-kmp
• Owner: getspherelabs
• License: mit
• Created: 2023-08-31T11:31:05.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-03T01:26:32.000Z (over 1 year ago)
• Last Synced: 2024-04-18T06:58:19.897Z (9 months ago)
• Topics: combine, compose, coroutines, cosmos, jetpackcompose, kmm, kmp, koin, kotlin, kotlin-multiplatform, kotlin-multiplatform-mobile, ktor, sqldelight, swift, swiftui
• Language: Kotlin
• Homepage:
• Size: 2.82 MB
• Stars: 85
• Watchers: 1
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


   




# Architecture

The app architecture has three layers: a data layer, a domain layer and a UI layer. Cosmo uses [Meteor KMP](https://github.com/getspherelabs/meteor-kmp) to create application using MVI architecture. It provides a unidirectional data flow (UDF), allowing you to handle state changes and propagate them to the UI efficiently.

# Technology

- [Kotlin]()

- [Kotlin Coroutine]()

- [Swift]()

- [Jetpack Compose]()

- [SwiftUI]()

- [Ktor]()

- [SqlDelight]()

- [Koin]()

- [Meteor]()

- [Multiplatform Settings]()

- [Moko KSwift]()

- [Combine]()

- [Coil]()

- [Meteor ViewModel]()

- [NavigationStack]()

- [Turbine]()

- [Ktlint]()

- [Spotless]()

- [Jacoco]()

# Modularization

Modularization is the practice of breaking the concept of a monolithic, one-module codebase into loosely coupled, self contained modules.

A barebone module is simply a directory with a Gradle build script inside. Usually though, a module will consist of one or more source sets and possibly a collection of resources or assets. Modules can be built and tested independently. Due to Gradle's flexibility there are few constraints as to how you can organize your project. In general, you should strive for low coupling and high cohesion.

- **Low coupling** - Modules should be as independent as possible from one another, so that changes to one module have zero or minimal impact on other modules. They should not possess knowledge of the inner workings of other modules.

- **High cohesion** - A module should comprise a collection of code that acts as a system. It should have clearly defined responsibilities and stay within boundaries of certain domain knowledge.

```mermaid

graph TD;

    shared-->androidApp;

    shared-->iosApp;

    featureAbout-->shared;

    featureOnboarding-->shared;

    featureDiscover-->shared;

    featureFavourite-->shared;

    featureDetail-->shared;

    data-->local;

    data-->settings;

    data-->network;

    local-->featureDetail;

    local-->featureFavourite;

    network-->featureDiscover;

    network-->featureDetail;

    settings-->featureOnboarding;

```

# Screenshots

| Android (Jetpack Compose)              | IOS     (SwiftUI)    |

| ---------------------- | ---------------------- |

| ![android](docs/imgs/android_screenshot.png) | ![ios](docs/imgs/ios_screenshot.png) |

  

# Testing

With a testable app architecture, the code follows a structure that allows you to easily test different parts of it in isolation. Testable architectures have other advantages, such as better readability, maintainability, scalability, and reusability.

Unit tests for the data layer, especially repositories. Most of the data layer should be platform-independent.

# Setup

To build and run the Android client, you must use Android Studio Arctic Fox or a newer version.

For iOS development, you'll need XCode 13.2 or a later version, primarily because of the utilization of the new Swift 5.5 concurrency APIs. When you open the iOS project, please ensure that you open the `.xcworkspace` file instead of the `.xcodeproj` file.