Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/patilshreyas/foodium-kmm

📱Sample application built to demonstrate the use of Kotlin Multiplatform Mobile for developing Android and iOS applications using Jetpack Compose 🚀.
https://github.com/patilshreyas/foodium-kmm

android android-app coroutines hacktoberfest ios ios-app kmm kmm-sample kmp kotlin kotlin-multiplatform ktor sample

Last synced: 5 days ago
JSON representation

📱Sample application built to demonstrate the use of Kotlin Multiplatform Mobile for developing Android and iOS applications using Jetpack Compose 🚀.

Host: GitHub
URL: https://github.com/patilshreyas/foodium-kmm
Owner: PatilShreyas
License: apache-2.0
Created: 2023-04-15T16:00:13.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-01-24T09:17:06.000Z (11 months ago)
Last Synced: 2024-10-14T03:43:17.503Z (2 months ago)
Topics: android, android-app, coroutines, hacktoberfest, ios, ios-app, kmm, kmm-sample, kmp, kotlin, kotlin-multiplatform, ktor, sample
Language: Kotlin
Homepage:
Size: 92.6 MB
Stars: 321
Watchers: 4
Forks: 23
Open Issues: 5
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

![](/readme-media/graphic.png)

# 🍲 Foodium (Kotlin Multiplatform Mobile)

Foodium is a simple and sample _mobile application_ built to demonstrate the use of
_**Kotlin Multiplatform Mobile**_ for developing _Android and iOS_ applications
using **Jetpack Compose** 🚀.

| Platforms | ![](https://img.shields.io/badge/Android-black.svg?style=for-the-badge&logo=android) ![](https://img.shields.io/badge/iOS-black.svg?style=for-the-badge&logo=apple) |
|-----------|---|
| Status | [![Build](https://github.com/PatilShreyas/Foodium-KMM/actions/workflows/build.yml/badge.svg)](https://github.com/PatilShreyas/Foodium-KMM/actions/workflows/build.yml) |

## About

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 always
synchronized.

**Features:**

- [x] Offline capability 📵
- [x] Dark mode 🌓
- [x] Clean and Simple Material UI 🎨

The network API is a dummy (fixed) response which is _statically hosted
[here](https://patilshreyas.github.io/DummyFoodiumApi/api/posts/)_. The concept of this app is
originally taken from [this project](https://github.com/PatilShreyas/Foodium/).

### 📱 Preview

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

#### ▶️ Android

https://user-images.githubusercontent.com/19620536/235439485-b2d0e7c9-e7fd-4313-adbc-aa259aaed6ec.mp4

#### ▶️ iOS

https://user-images.githubusercontent.com/19620536/235439532-457f0ccf-d18f-467d-a3c8-8b2fc45d6e01.mp4

---

## Built with

- [Kotlin](kotlinlang.org): Programming language
- [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html): For building multi-platform applications in the single codebase.
- [Jetpack/JetBrains Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/): For a shared UI between multi-platforms i.e. Android and iOS in this project.
- Kotlinx
- [Coroutines](https://github.com/Kotlin/kotlinx.coroutines): For multithreading
- [Serialization](https://github.com/Kotlin/kotlinx.serialization): For JSON serialization/deserailization
- [Ktor Client](https://github.com/ktorio/ktor): Performing HTTP requests, Creating image loading utility for iOS module.
- [SQLDelight](https://github.com/cashapp/sqldelight): For persisting posts data in the local database
- [Coil](https://github.com/coil-kt/coil): Image loading for Android
- [Mutekt](https://github.com/PatilShreyas/mutekt): For UI state management

## Setting up project 👨🏻‍💻

- Refer to the ***"Setting up environment"*** section of [this repository](https://github.com/JetBrains/compose-multiplatform-ios-android-template/main/README.md)
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)_.

## Project structure

This Compose Multiplatform project includes three modules:

### [`shared`](/shared)
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 `shared/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`](/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`](/iosApp)
This is an Xcode project that builds into an iOS application. It depends on and uses the shared module as a CocoaPods dependency.

---

## Contribute

If you want to contribute to this library, you're always welcome!
See [Contributing Guidelines](CONTRIBUTING.md).

## Discuss 💬

Have any questions, doubts or want to present your opinions, views? You're always welcome.
You can [start discussions](https://github.com/PatilShreyas/Foodium-KMM/discussions).

## Acknowledgements

- [JetBrains/compose-multiplatform-ios-android-template](https://github.com/JetBrains/compose-multiplatform-ios-android-template#readme):
For Starter template
- [google/accompanist](https://github.com/google/accompanist): For placeholder (shimmer animation)
APIs

## License

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.
```