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

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

Last synced: 4 days ago
JSON representation

Harmony framework for Kotlin

• Host: GitHub
• URL: https://github.com/franmontiel/harmony-kotlin
• Owner: franmontiel
• License: apache-2.0
• Created: 2023-05-25T16:49:53.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-10-03T06:49:33.000Z (about 1 year ago)
• Last Synced: 2023-10-04T10:31:20.574Z (about 1 year ago)
• Language: Kotlin
• Homepage: https://harmony.mobilejazz.com
• Size: 53.3 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

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.