Skip to content

⾞ NarutoCMP - A multiplatform app on Naruto characters based app for Android, iOS, Desktop.

Notifications You must be signed in to change notification settings

aritra-tech/NarutoCMP

Repository files navigation

⾞ NarutoCMP (Compose Multiplatform Mobile)

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

Platform Action
📱 Mobile
🖥️ Desktop

Features:

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

The network API is a dummy (fixed) response which is statically hosted here.

📱 Preview

Currently, the app looks like this on the both platforms i.e Android & iOS:

screen-recording-2024-01-31-at-40310-pm_KI2Sh2BF.mp4

Built with

  • Kotlin: Programming language
  • Jetpack/JetBrains Compose Multiplatform: For a shared UI between multi-platforms i.e. Android and iOS in this project.
  • Kotlinx
  • Ktor Client: Performing HTTP requests, Creating image loading utility for iOS module.
  • MOKO-MVVM: Model-View-ViewModel architecture components for mobile (android & ios) Kotlin Multiplatform development.
  • Voyager: A pragmatic navigation library for Jetpack Compose.
  • Kamel-Media: Kotlin asynchronous media loading and caching library for Compose.

Project structure

This is a Kotlin Multiplatform project targeting Android, iOS, Desktop.

  • /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

Contributing

Please read CONTRIBUTING.md for details and the process.

License

MIT License

Copyright (c) 2024 Aritra Das

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.