Skip to content

Realtime-Coding/TravelAppKMP

Repository files navigation

Travel APP (Kotlin Multiplatform Mobile)

Travel App is a simple mobile application built to demonstrate the use of Kotlin Multiplatform Mobile for developing Android and iOS applications using Jetpack Compose 🚀.

Android IOS MacOS MSI Desktop Windows Web

Cover-Travel-App-KMM

📱 Preview

Currently, the app looks like this on platforms:

▶️ Android, IOS & Desktop

https://drive.google.com/file/d/1aDrhqpvc4XUdEaO-6aBZrE6HRFglDnl_/view?usp=sharing


Built with

  • Kotlin: Programming language
  • Kotlin Multiplatform: For building multi-platform applications in the single codebase.
  • Jetpack/JetBrains Compose Multiplatform: For a shared UI between multi-platforms i.e. Android and iOS in this project.
  • Moko Resources: This is a Kotlin MultiPlatform library (and Gradle plugin) that provides access to the resources on macOS, iOS, Android the JVM and JS/Browser with the support of the default system localization.
  • Compose Image Loader: Compose Image library for Kotlin Multiplatform.

TODOs

✅ Completed

  • Home screen UI.
  • Destination Detail screen UI.
  • Favorite Detail screen UI.
  • Coil(Image loading from Url).
  • Bottom Navigation Menu.
  • Compose resources e-g images, strings and fonts.
  • Voyager (Navigation).
  • Cart Screen Design.
  • CI/CD Configure for IOS, Android, MacOS, Window, Web.
  • CI/CD generate artifacts to download
  • CI/CD to publish web app on github pages

🚧 Work in progress

  • Profile Screen Design.
  • Room setup for adding favorites.
  • Switch for dark/light theme.
  • Shifting content to github repo then fetch details through ktor client library.
  • MVVM Implementation
  • Testing

Project structure

This Compose Multiplatform project includes three modules:

This is a Kotlin module that contains the common UI/logic 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 composeApp/build.gradle.kts. The shared module builds into an Android library and an iOS framework.

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

Setting up project 👨🏻‍💻

  • Refer to the "Setting up environment" section of this repository for knowing the setup guidelines
  • After validating requirements as per the above guide, clone this repository.
  • Open this project in Android Studio Electric Eel or newer version.
  • Build project 🔨 and see if everything is working fine.
  • Run App
    • Select "androidApp" as run configuration and you'll be able to run the Android app.
    • Select "iosApp" as run configuration and you'll be able to run the iOS app (XCode can also be used to run the app).
    • Desktop Screenshot 2024-07-24 at 1 29 16 PM Screenshot 2024-07-24 at 1 29 49 PM

Contribute

If you want to contribute to this library, you're always welcome!

Acknowledgements

Want to create Project in KMM? Step by Step Documentations

Notion file: Documentations