Repository files navigation

Foodium is a simple and samplemobile application built to demonstrate the use ofKotlin Multiplatform Mobile for developingAndroid and iOS applicationsusingJetpack Compose 🚀.

Platforms
Status

It simply loads Posts data from API and stores it in persistence storage (i.e. SQLite Database).Posts will be always loaded from local database. Remote data (from API) and Local data is alwayssynchronized.

Features:

• Offline capability 📵
• Dark mode 🌓
• Clean and Simple Material UI 🎨

The network API is a dummy (fixed) response which isstatically hostedhere. The concept of this app isoriginally taken fromthis project.

Currently, the app looks like this on the both platforms:

• 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.
• Kotlinx
  • Coroutines: For multithreading
  • Serialization: For JSON serialization/deserailization
• Ktor Client: Performing HTTP requests, Creating image loading utility for iOS module.
• SQLDelight: For persisting posts data in the local database
• Coil: Image loading for Android
• Mutekt: For UI state management

• Refer to the"Setting up environment" section ofthis repositoryfor 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).

This Compose Multiplatform project includes three modules:

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. Inshared/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 inshared/build.gradle.kts. The shared module builds into an Android library and an iOS framework.

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

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

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

Have any questions, doubts or want to present your opinions, views? You're always welcome.You canstart discussions.

• JetBrains/compose-multiplatform-ios-android-template:For Starter template
• google/accompanist: For placeholder (shimmer animation)APIs

Copyright 2023 Shreyas PatilLicensed 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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.