README.md

MidJourney Images Compose Multiplatform Mobile Application

Featured in Google dev library

This application is developed to display the images created by MidJourney. The application is developed with Compose Multiplatform and works on Android, iOS, Web, Wear OS, Android Automotive, Android TV platforms.

Application developed in the MVVM concept using Kotlin and Jetpack Compose. Network request states, endless pagination, image loading, offline mode and image caching processes were performed.

Libraries Used

• Compose Multiplatform
• Ktor
• Koin
• Kotlinx Serialization
• Kotlinx Coroutines
• Coil
• Multiplatform Settings

Consumer apps do not have any complex structures or operations. They use the common UI layer (including ViewModel) and are responsible for creating MjImagesApp. MjImagesApp and the dependency of this Composable, MjImagesViewModel, works as same on all platforms.

Requirements

• MacOS
• Environment must be installed as described in the link.

Android Application

Run the following command to compile the Android application:

./gradlew :androidApp:assembleDebug

iOS Application

After the project is built, the iOS application can be run on any emulator or device. Android Studio or Xcode can be used.

Wear OS Application

After the project is built, the Wear OS application can be run on any emulator or device.

./gradlew :wearApp:assembleDebug

Android TV Application

After the project is built, the Android TV application can be run on any emulator or device.

./gradlew :televisionApp:assembleDebug

Android Automotive Application

After the project is built, the Android Automotive application can be run on any emulator (requires Android Studio Hedgehog) or device.

./gradlew :automotiveApp:assembleDebug

Desktop Application

This project can be built for Windows, Debian, and MacOS.

./gradlew desktopApp:run

Building native desktop distribution

./gradlew :desktop:packageDistributionForCurrentOS
# outputs are written to desktopApp/build/compose/binaries

Web Application

This project can be built for the Compose for Web(JS). Demo

./gradlew :webApp:jsBrowserDevelopmentRun

Building web distribution

./gradlew :webApp:jsBrowserDevelopmentExecutableDistribution
./gradlew :webApp:jsBrowserDistribution

Wasm Application

This project can be built for the Compose for Web(Wasm). Demo

./gradlew :wasmApp:wasmBrowserDevelopmentRun

Building wasm distribution

./gradlew :wasmApp:wasmBrowserDevelopmentExecutableDistribution
./gradlew :wasmApp:wasmJsBrowserDistribution

Testing

The application has Compose UI tests, Maestro UI tests, and unit tests. The unit tests are written under the common package with fake data. The UI tests are written under the androidTest package. The Maestro tests are written under the maestro package.

• To run the unit tests, run the following command:

  ./gradlew :shared:cleanTestDebugUnitTest :shared:testDebugUnitTest

• To run the Maestro Tests, execute the following command:

   maestro test .maestro

• To run the Android Instrumented UI tests, run the following command:

  ./gradlew :shared:connectedAndroidTest

API

The API used for the application is mj.akgns.com.

Translations

• Türkçe
• German

Medium

For more information, check out the Medium post.

Contributions 👏

Please feel free to open an issue; any contributions will be appreciated! Thank you in advance.

Contact

• Linkedin: https://www.linkedin.com/in/mbakgun
• Twitter: https://twitter.com/mbakguns
• Mastodon: https://androiddev.social/@mbakgun

License

  MIT License

  Copyright (c) 2023 Mehmet Burak Akgün 
  
  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.