https://github.com/ch8n/kodak-kmp

Image loading library for KMP, supports Android, IOS, Desktop and Web(Wasm)
https://github.com/ch8n/kodak-kmp

Last synced: 14 days ago
JSON representation

Image loading library for KMP, supports Android, IOS, Desktop and Web(Wasm)

• Host: GitHub
• URL: https://github.com/ch8n/kodak-kmp
• Owner: ch8n
• Created: 2024-08-16T15:32:43.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-17T18:01:53.000Z (5 months ago)
• Last Synced: 2024-10-30T20:13:34.249Z (2 months ago)
• Language: Kotlin
• Size: 271 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Kodak-KMP 📸 - Work In Progress

Kodak-KMP is a Kotlin Multiplatform project that implements an image loading library from scratch using Jetpack Compose. This library supports multiple platforms, including Android, iOS, Desktop, and Web (Wasm). It offers efficient, asynchronous image loading with robust caching and memory management mechanisms.

## 🌍 Supported Platforms

- **Android**

- **iOS**

- **Desktop**

- **Web (Wasm)**

## 🛠 Features

- **Asynchronous Image Loading**: Load images from a URL asynchronously using Ktor and Coroutines.

- **Jetpack Compose Compatibility**: Seamlessly integrates with Jetpack Compose for modern UI development.

- **Image Placeholder**: Displays placeholders for both loading and error states to enhance user experience.

- **Caching Mechanism**: Implements both memory and disk caching to optimize loading times and reduce redundant network calls.

- **Memory Management**: Efficiently manages memory by avoiding loading high-quality or raw images unnecessarily.

## 🏗 Functional Requirements

1. **Asynchronous Image Loading from URL**: Fetch images from remote servers without blocking the main thread.

2. **Compatible with Jetpack Compose**: Fully compatible with Jetpack Compose for all target platforms.

3. **Image Placeholder**: Show placeholders during image loading and in case of loading errors.

4. **Caching Mechanism**: Utilize both memory and disk caching strategies to store images.

5. **Memory Management**: Optimize memory usage by preventing the loading of high-quality or raw images when not needed.

## How to use?

### Installation

* `/composeApp` is for code that will be shared across your Compose Multiplatform applications.

  It contains several subfolders:

  - `commonMain` is for code that’s common for all targets.

  - Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name.

    For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app,

    `iosMain` would be the right folder for such calls.

* `/iosApp` contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform, 

  you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project.

Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html),

[Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform/#compose-multiplatform),

[Kotlin/Wasm](https://kotl.in/wasm/)…

We would appreciate your feedback on Compose/Web and Kotlin/Wasm in the public Slack channel [#compose-web](https://slack-chats.kotlinlang.org/c/compose-web).

If you face any issues, please report them on [GitHub](https://github.com/JetBrains/compose-multiplatform/issues).

You can open the web application by running the `:composeApp:wasmJsBrowserDevelopmentRun` Gradle task.

## 📚 Learn More

For a detailed explanation of the system design and implementation, please refer to the Medium article that covers all the essential concepts and decisions made during the development of Kodak-KMP.

## 🛡 License

This project is licensed under the MIT License. See the LICENSE file for more details.

##🙌 Contributions

Contributions are welcome! Please open an issue or submit a pull request to contribute.

## 📞 Contact

If you have any questions or feedback, feel free to reach out via social handles

[LinkedIn](https://bit.ly/ch8n-linkdIn) |

[Medium](https://bit.ly/ch8n-medium-blog) |

[Twitter](https://bit.ly/ch8n-twitter) |

[StackOverflow](https://bit.ly/ch8n-stackOflow) |

[CodeWars](https://bit.ly/ch8n-codewar) |

[Portfolio](https://bit.ly/ch8n-home) |

[Github](https://bit.ly/ch8n-git) |

[Instagram](https://bit.ly/ch8n-insta) |

[Youtube](https://bit.ly/ch8n-youtube)