Skip to content

Latest commit

 

History

History
150 lines (119 loc) · 7.97 KB

README.md

File metadata and controls

150 lines (119 loc) · 7.97 KB
Raw

KMP Movie (Compose Multiplatform)

Compose Multiplatform Kotlin ktorCleint badge-Android badge-iOS badge-desktop badge-web GitHub license License

KMP Movie app built with Compose Multiplatform, supporting Android, iOS, Desktop, and Web. The app follows the MVVM architecture to ensure clean, maintainable code and delivers a responsive, modern UI experience across all platforms, leveraging The Movie DB API.

Platform

  • iOS
  • Android
  • Desktop
  • Web





Main Features

  • Movie
    • Movie List
    • Movie Search
    • Movie Detail
    • Recommended Movie
  • TV Series
    • TV Series List
    • TV Series Search
    • TV Series Detail
    • Recommended TV Series
  • Artist Detail
  • Bottom Navigation
  • Navigation Rail

Architecture

  • MVVM Architecture (Model - ComposableView - ViewModel)

API Key 🔑

You will need to provide a developer key to fetch the data from TMDB API.

  • Generate a new key (v3 auth) from here. Copy the key and go back to the project.
  • Add the key to build config in ./composeApp/build.gradle.kts:
defaultConfig {
    ...
    buildConfigField("API_KEY", TMDB_API_KEY)
    ...
}

Built With 🛠

  • Compose Multiplatform - Compose Multiplatform, a modern UI framework for Kotlin that makes building performant and beautiful user interfaces.
  • PreCompose - Compose Multiplatform Navigation && State Management
  • Ktor Client - Ktor includes a multiplatform asynchronous HTTP client, which allows you to make requests and handle responses.
  • kotlinx.serialization - Kotlin multiplatform / multi-format reflectionless serialization
  • View Model - The ViewModel class is a business logic or screen level state holder. It exposes state to the UI and encapsulates related business logic
  • Coroutines - For asynchronous and more.
  • Flow - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception.
  • Landscapist - 🌻 A pluggable, highly optimized Jetpack Compose and Kotlin Multiplatform image loading library that fetches and displays network images with Glide, Coil, and Fresco.
  • Android Studio - Android Studio is the official Integrated Development Environment (IDE) for Android app development.
  • XCode - Xcode 14 includes everything you need to develop, test, and distribute apps across all Apple platforms.

Before running!

  • check your system with KDoctor
  • install JDK 11 or higher on your machine
  • add local.properties file to the project root and set a path to Android SDK there

Android

To run the application on Android device/emulator:

  • open the project in Android Studio and run the imported android run configuration

To build the application bundle:

  • run ./gradlew :composeApp:assembleDebug
  • find .apk file in composeApp/build/outputs/apk/debug/composeApp-debug.apk Run android simulator UI tests: ./gradlew :composeApp:pixel5Check

iOS

To run the application on an iPhone device/simulator:

  • Open iosApp/iosApp.xcproject in Xcode and run standard configuration
  • Or use Kotlin Multiplatform Mobile plugin for Android Studio Run iOS simulator UI tests: ./gradlew :composeApp:iosSimulatorArm64Test

Desktop

  • Run the desktop application: ./gradlew :composeApp:run
  • Run desktop UI tests: ./gradlew :composeApp:jvmTest

Web

  • Before running make sure you have yarn 1.22.22
  • Run the web application: ./gradlew wasmJsBrowserRun

Project structure

This Compose Multiplatform project includes three modules:

composeApp

This is a Kotlin module that contains the logic common for both Android and iOS applications, the code you share between platforms. This shared module is also where you write your Compose Multiplatform code. In composeApp/src/commonMain/kotlin/App.kt, you can find the shared root @Composable function for your app. It uses Gradle as the build system. You can add dependencies and change settings in shared/build.gradle.kts. The shared module builds into an Android library and an iOS framework.

androidApp

This is a Kotlin module that builds into an Android application. It uses Gradle as the build system. The androidApp module depends on and uses the shared module as a regular Android library.

iosApp

This is an Xcode project that builds into an iOS application. It depends on and uses the shared module as a CocoaPods dependency.

Acknowledgements

👨 Developed By

Mehedi Hassan Piash

Twitter Medium Linkedin Web Blog

License

Copyright 2024 piashcse (Mehedi Hassan Piash)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.