https://github.com/mobilejazz/harmony-kotlin

Harmony framework for Kotlin
https://github.com/mobilejazz/harmony-kotlin

android clean-architecture clean-code kotlin kotlin-android kotlin-multiplatform

Last synced: about 2 months ago
JSON representation

Harmony framework for Kotlin

• Host: GitHub
• URL: https://github.com/mobilejazz/harmony-kotlin
• Owner: mobilejazz
• License: apache-2.0
• Archived: true
• Created: 2019-06-26T22:30:23.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-08-06T17:55:35.000Z (over 1 year ago)
• Last Synced: 2024-09-21T18:15:04.394Z (about 2 months ago)
• Topics: android, clean-architecture, clean-code, kotlin, kotlin-android, kotlin-multiplatform
• Language: Kotlin
• Homepage: https://harmony.mobilejazz.com
• Size: 53.2 MB
• Stars: 12
• Watchers: 17
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-list - mobilejazz/harmony-kotlin - Harmony framework for Kotlin (Kotlin)

README

        


  

    

  

Harmony Kotlin


  


    Harmony is a framework developed by Mobile Jazz that specifies best practices, software architectural patterns and other software development related guidelines.

    


    


    Documentation

    ·

    TypeScript

    ·

    Swift

    ·

    PHP

  


## Installation

Add the dependency for the multiplatform artifact (to be used on KMM project)

```groovy

dependencies {

  implementation 'com.mobilejazz:harmony-kotlin:6.0.0'

}

```

Or if you need to use it on a particular platform you can use the following artifacts

```groovy

  implementation 'com.mobilejazz:harmony-kotlin-android:6.0.0'

  implementation 'com.mobilejazz:harmony-kotlin-jvm:6.0.0'

  implementation 'com.mobilejazz:harmony-kotlin-iosx64:6.0.0'

  implementation 'com.mobilejazz:harmony-kotlin-iossimulatorarm64:6.0.0'

  implementation 'com.mobilejazz:harmony-kotlin-iosarm64:6.0.0'

```

**Android apps** targetting devices running **below API 26** need to use Android Gradle plugin 4.0 or newer and enable [core library desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring). This is required due to the usage of [kotlinx-datetime](https://github.com/Kotlin/kotlinx-datetime)

## Migrating from 4.0 to 5.X

Apps migrating to version 5.0 must perform the following operations:

 - Follow Ktor 2.0 [migration guide](https://ktor.io/docs/migrating-2.html)

## Author

Mobile Jazz, [email protected]

## API Reference

[https://harmony.mobilejazz.com/](https://harmony.mobilejazz.com/)

## License

Harmony is available under the Apache 2.0 license. See the LICENSE file for more info.