Skip to content

Latest commit

 

History

History
121 lines (86 loc) · 4.42 KB

README.md

File metadata and controls

121 lines (86 loc) · 4.42 KB

kotlin-kmm-kennzeichner

tl;dr

This is currently a playground to get to know with Kotlin Multiplatform in combination with a shared Jetpack Compose and SwiftUI.

The app(s) will provide a look for for German license plate IDs such as "A" for Augsburg, "M" for Munich, etc. pp. The long time goal is to roll out this limited set of features to more KMM-able platforms such as desktop or the web.

Kennzeichner Logo

Build status

Service Status
- -

Keep in mind

Not production ready

This app is purely build for having fun! All features have room for improvements or could be done more elegant. This app was and will be never meant to run in production-like environments. Learning is fun!

Not all license plates are available

To generate the JSON file with all licesense plates and their meta information, I had to do a lot of manual work. Because of the fact that my focus is set to "KMP evaluation" and not 100% data coverage, it might be that some license plates are missing.

Publications

Requirements

Android app

  • Windows / Linux / macOS
  • Android Studio with KMP plugin
  • Google Maps App Key in local.properties

iOS App

  • macOS Ventura+
  • Xcode Command line tools 13.4

Versions

0.3.* (iOS MVP)

Main features

  • MVP-ish finished iOS App with list, detail, map and filter features.
  • Updated toolchain to Xcode 15 and iOS 17
  • Updated Readme to cover how to run the project

UI

Version 0.3.0

0.2.* (Android MVP)

Main features

  • MVP-ish finished Android App with list, detail, map and filter features.
  • Added future-proof dependencies like Koin
  • Migrated from PoC to stable MVVM pattern
  • Added documentation to Kotlin files

UI

Version 0.2.1

0.1 (Project setup)

Main features

Successful run of the Android Studio Kotlin Mobile Multiplatform. Tested by starting the Android and iOS application.

UI

Version 0.1.0

Feature roadmap

Setup

  • Project setup
  • Find data source of license plate ids

Core functionality

  • List license plates id
  • Show detail of a license plate id

UI

Android (Compose)

  • Create list view
  • Create detail view
  • Create map view with markers
  • Add searchbar to filter lists

iOS (SwiftUI)

  • Create list view
  • Create detail view
  • Create map view with markers
  • Add searchbar to filter lists

Future feature ideas

  • Add digital assistant support
  • Add "fav" and "share" feature

Instruments

  • Check how's the memory consumption
  • Check if there is no memory leakage

Authors

Just me, Tobi.

Links

Thanks to

The app is built on the work of giants. Without the following folks, repositories and posts, my tiny project would not exist.

License

This project is licensed under the MIT License - see the LICENSE file for details. Dependencies or assets maybe licensed differently.