diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..d7966bf
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,4 @@
+# noinspection EditorConfigKeyCorrectness
+[*.{kt,kts}]
+ktlint_code_style = android_studio
+ktlint_function_naming_ignore_when_annotated_with=Composable
\ No newline at end of file
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..279b185
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,22 @@
+
+
+
+Issue: https://github.com/touchlab/KaMPKit/issues/[issue number]
+
+## Summary
+
+
+## Fix
+
+
+## Testing
+
+- `./gradlew :app:build`
+- `./gradlew :shared:build`
+- `xcodebuild -workspace ios/KaMPKitiOS.xcworkspace -scheme KaMPKitiOS
+ -sdk iphoneos -configuration Debug build -destination name="iPhone 8"`
+- manual testing
+
+
+### **Screenshot / Video of App working with the Changes**
+
\ No newline at end of file
diff --git a/.github/workflows/KaMPKit-Android.yml b/.github/workflows/KaMPKit-Android.yml
new file mode 100644
index 0000000..170be2d
--- /dev/null
+++ b/.github/workflows/KaMPKit-Android.yml
@@ -0,0 +1,33 @@
+name: KaMPKit-Android
+
+on:
+ workflow_dispatch:
+ push:
+ branches:
+ - main
+ pull_request:
+ paths-ignore:
+ - "**.md"
+ - "*.png"
+ - docs
+ - ios
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions/setup-java@v4
+ with:
+ distribution: corretto
+ java-version: 17
+
+ - name: Setup Gradle
+ uses: gradle/actions/setup-gradle@v4
+
+ - name: Build
+ run: ./gradlew build
+
+
+
diff --git a/.github/workflows/KaMPKit-iOS.yml b/.github/workflows/KaMPKit-iOS.yml
new file mode 100644
index 0000000..6de6176
--- /dev/null
+++ b/.github/workflows/KaMPKit-iOS.yml
@@ -0,0 +1,42 @@
+name: KaMPKit-iOS
+
+on:
+ workflow_dispatch:
+ push:
+ branches:
+ - main
+ pull_request:
+ paths-ignore:
+ - "**.md"
+ - "*.png"
+ - docs
+ - app
+
+jobs:
+ build:
+ runs-on: macos-latest
+
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions/setup-java@v4
+ with:
+ distribution: corretto
+ java-version: 17
+
+ - name: Setup Gradle
+ uses: gradle/actions/setup-gradle@v4
+
+ - name: Run tests
+ run: ./gradlew :shared:iosX64Test
+
+ - name: Build
+ uses: sersoft-gmbh/xcodebuild-action@v1
+ with:
+ project: ios/KaMPKitiOS.xcodeproj
+ scheme: KaMPKitiOS
+ destination: name=iPhone 8
+ sdk: iphoneos
+ configuration: Debug
+ action: build
+ use-xcpretty: false
+ build-settings: CODE_SIGN_IDENTITY= CODE_SIGNING_REQUIRED=NO
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..6eedae1
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,15 @@
+*.iml
+.gradle
+/local.properties
+/.idea
+.DS_Store
+/build
+/buildSrc/build
+/captures
+.externalNativeBuild
+.cxx
+*.xcuserstate
+*.xcbkptlist
+!/.idea/codeStyles/*
+!/.idea/inspectionProfiles/*
+.kotlin
\ No newline at end of file
diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml
new file mode 100644
index 0000000..2582293
--- /dev/null
+++ b/.idea/codeStyles/Project.xml
@@ -0,0 +1,136 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ xmlns:android
+
+ ^$
+
+
+
+
+
+
+
+
+ xmlns:.*
+
+ ^$
+
+
+ BY_NAME
+
+
+
+
+
+
+ .*:id
+
+ http://schemas.android.com/apk/res/android
+
+
+
+
+
+
+
+
+ .*:name
+
+ http://schemas.android.com/apk/res/android
+
+
+
+
+
+
+
+
+ name
+
+ ^$
+
+
+
+
+
+
+
+
+ style
+
+ ^$
+
+
+
+
+
+
+
+
+ .*
+
+ ^$
+
+
+ BY_NAME
+
+
+
+
+
+
+ .*
+
+ http://schemas.android.com/apk/res/android
+
+
+ ANDROID_ATTRIBUTE_ORDER
+
+
+
+
+
+
+ .*
+
+ .*
+
+
+ BY_NAME
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml
new file mode 100644
index 0000000..0f7bc51
--- /dev/null
+++ b/.idea/codeStyles/codeStyleConfig.xml
@@ -0,0 +1,5 @@
+
+
+
+
+
diff --git a/.idea/inspectionProfiles/ktlint.xml b/.idea/inspectionProfiles/ktlint.xml
new file mode 100644
index 0000000..0938bfd
--- /dev/null
+++ b/.idea/inspectionProfiles/ktlint.xml
@@ -0,0 +1,43 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml
new file mode 100644
index 0000000..64580d1
--- /dev/null
+++ b/.idea/inspectionProfiles/profiles_settings.xml
@@ -0,0 +1,6 @@
+
+
+
+
+
+
diff --git a/CONTACT_US.md b/CONTACT_US.md
new file mode 100644
index 0000000..b8e2a1c
--- /dev/null
+++ b/CONTACT_US.md
@@ -0,0 +1,11 @@
+# Contact Us
+
+KaMP Kit support can be found in the Kotlin Community Slack. Look for the `kampkit-support` channel.
+
+To join the Kotlin Community Slack, [request access here](http://slack.kotlinlang.org/)
+
+For direct assistance, please [reach out to Touchlab](https://go.touchlab.co/contactkamp) to discuss support options.
+
+If you find any bugs or issues in with project, you can create an issue in
+the [GitHub repository](https://github.com/touchlab/KaMPKit), but please don't mistake it with general KMP helpline. You
+can get answers for general questions in Slack.
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..0a42350
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "{}"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright 2020 Touchlab
+
+ 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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4149062
--- /dev/null
+++ b/README.md
@@ -0,0 +1,172 @@
+[](https://github.com/touchlab/KaMPKit/actions/workflows/KaMPKit-Android.yml)
+[](https://github.com/touchlab/KaMPKit/actions/workflows/KaMPKit-iOS.yml)
+
+# KaMP Kit
+
+
+
+***Welcome to KaMP Kit!***
+
+## Intro
+
+KaMP Kit started in early 2020 with the goal of helping developers interested in Kotlin Multiplatform (aka KMP) get started
+quickly with a great set of libraries and patterns. At the time, there were not many sample apps and getting started
+was not trivial. The KMP situation has improved considerably since then, and various barriers to entry have been
+removed.
+
+Whereas KaMP Kit started with the goal of being a minimal sample, we now intend it to be less "getting started" and
+more "best practice model". Watch this repo and follow [@TouchlabHQ](https://twitter.com/TouchlabHQ) for updates!
+
+### 2023 Update
+
+We updated `KaMPKit` to make sure of Touchlab's new [SKIE](https://skie.touchlab.co/) tool. SKIE allowed use to remove a lot of boilerplate code related to `ViewModel` sharing, and also we can now use Kotlin sealed classes as Swift enums in iOS code. Take a look at our detailed [migration case study](https://touchlabpro.touchlab.dev/touchlab/training/skie-architecture/migrating-kampkit-to-skie)
+
+> ## Subscribe!
+>
+> We build solutions that get teams started smoothly with Kotlin Multiplatform and ensure their success in production. Join our community to learn how your peers are adopting KMP.
+ [Sign up here](https://touchlab.co/?s=shownewsletter)!
+
+## Getting Help
+
+KaMP Kit support can be found in the Kotlin Community Slack, [request access here](http://slack.kotlinlang.org/). Post in the [#touchlab-tools](https://kotlinlang.slack.com/archives/CTJB58X7X) channel.
+
+For direct assistance, please [contact Touchlab](https://go.touchlab.co/contactkamp) to discuss support options.
+
+## About
+
+### Goal
+
+The goal of KaMP Kit is to facilitate your evaluation of KMP. It is a collection of code and
+tools designed to get you started quickly. It's also a showcase of Touchlab's typical choices for architecture,
+libraries, and other best practices.
+
+The KMP ecosystem has generated a lot of excitement, and has evolved very rapidly. As a result, there's a lot of old or
+conflicting documentation, blog posts, tutorials, etc. We, Touchlab, have worked with several teams looking at KMP, and have found that the **primary** stumbling block is simply getting started.
+
+KaMP Kit is designed to get you past that primary stumbling block. You should be able to set up your development environment, clone the repo, and have a running sample app very quickly. From there, you can focus on what you want to build.
+
+#### *Very Important Message!!!*
+
+This kit exists because the info you may find from Google about KMP is likely to be outdated or conflicting with the config here. It is highly recommended that you reach out directly if you run into issues.
+
+### Audience
+
+We (Touchlab) are focused primarily on using KMP for native mobile development. As a result, this kit is primarily targeted at native mobile developers (Android or iOS), as well as engineering managers for native mobile teams. You should have little-to-no experience with KMP, although some of the information after setup may be useful if you do have KMP experience.
+
+## What's Included?
+
+1. The Starter App - A native mobile KMP app with a small functional feature set.
+2. Educational Resources - Introductory information on KMP and Kotlin/Native.
+3. Integration Information - If you're integrating shared code into an existing application, guides to assist with that effort.
+
+## What's *Not* Included?
+
+Comprehensive guides, advanced tutorials, or generally support for fixing anything not included in the starter app. The goal is to have a solid starting point from which you can create something meaningful for evaluating KMP. We're intentionally limiting the scope to keep focus.
+
+# The Starter App
+
+The central part of the "Kit" is the starter app. It includes a set of libraries that we use in our apps that provide for much of the architectural needs of a native mobile application. We've also included a simple set of features you can use as a reference when adding your features.
+
+## 1) Dev Environment and Build Setup
+
+You will need the following:
+
+- JVM 17
+- Android SDK and the latest stable Android Studio (2023.3+) or IntelliJ(2024.1+)
+- Mac with Xcode 15+ for the iOS build
+
+For a more detailed guide targeted at iOS developers, see [DETAILED_DEV_SETUP](docs/DETAILED_DEV_SETUP.md).
+
+## 2) Clone and Build
+
+See [APP_BUILD](docs/APP_BUILD.md) for detailed build instructions. By the end of that doc you should be able to build and run both Android and iOS apps.
+
+---
+
+## Sanity Check
+
+At this point, you should be able to build Android and iOS apps. **If you cannot build, you need to get help.** This sample app is configured to run out of the box, so if it's not working, you have something wrong with your build setup or config. Please [reach out to us](CONTACT_US.md) so we can improve either the config or troubleshooting docs, and/or the Kotlin Slack group mentioned above.
+
+---
+
+## 3) Walk Through App
+
+Take a walk through the app's code and libraries. Make changes, recompile. See how it works.
+
+[GENERAL_ARCHITECTURE](docs/GENERAL_ARCHITECTURE.md)
+
+## 4) Background Education
+
+If the app is building, it's a good time to take a break and get some background information.
+
+### KMP Intro
+
+It's important to understand not just how to set up the platform, but to get a better perspective on what the tech can do and why we think it'll be very successful. KMP is distinct from other code sharing and "cross platform" systems, and understanding those distinctions is useful.
+
+[Longer intro to KaMP Kit](docs/WHAT_AND_WHY.md) - Original version of this doc's intro. Cut because it was pretty long.
+
+[Intro to Kotlin Multiplatform](https://vimeo.com/371428809) - General intro to KMP from Oredev in Nov 2019. Good overall summary of the platform.
+
+### "Selling" KMP
+
+KaMPKit can help you demonstrate to management and other stakeholders the value of sharing code with KMP. Check out these resources for more advice on pitching KMP to your team:
+
+[Kotlin Multiplatform Mobile for Teams](https://www.youtube.com/watch?v=-tJvCOfJesk&t=2145s)
+
+[Building a Business Case for KMP](https://touchlab.co/building-business-case-kotlin-multiplatform/)
+
+[7 ways to convince your engineering manager to pilot Kotlin Multiplatform](https://touchlab.co/7-ways-convince-engineering-manager-pilot-kotlin-multiplatform/)
+
+### Xcode Debugging
+
+For information on how to debug Kotlin in Xcode, check out the [Debugging Kotlin In Xcode](docs/DEBUGGING_KOTLIN_IN_XCODE.md) doc.
+
+## 5) Integrating 'shared' With Existing Apps
+
+As part of your evaluation, you'll need to decide if you're going to integrate KMP into existing apps. Some teams feel integrating with their production apps is a better demonstration of KMP's viability. While KMP's interop is great, relative to other technologies, **integrating *anything* into a production app build process can be a difficult task**. Once integrated, development is generally smooth, but modifying production build systems can be a time consuming task.
+
+[Adopting Kotlin Multiplatform In Brownfield Applications](https://www.youtube.com/watch?v=rF-w_jL0qsI)
+
+### Android
+
+The Android side is somewhat more straightforward. Android development is Kotlin-first nowadays, and the library can be integrated as just another module library. We'll be updating soon with a general Android integration doc. In the meantime, the simplest method would be to copy the shared module into your standard Android build, and use the `app` module as a reference for dependency resolution.
+
+### iOS
+
+The iOS integration process is relatively new and has been iterating fast. Be prepared to spend more time with config related issues when integrating with a production build.
+
+You can integrate with Cocoapods, or by directly including the Xcode framework. If you are an Android developer without extensive iOS build experience, be aware that this is a risky option. Production build systems, for any ecosystem, tend to be complex. You'll almost certainly need to recruit somebody with experience maintaining your iOS build.
+
+See [IOS_PROJ_INTEGRATION.md](docs/IOS_PROJ_INTEGRATION.md) for iOS integration information.
+
+If you are attempting to integrate your KMP project with a production iOS application, please let us know what issues you run into and reach out with questions if stuck. This is an ongoing area of improvement for the KMP platform and we'd like to help make this as smooth as possible.
+
+---
+
+## Troubleshooting
+
+[TROUBLESHOOTING](docs/TROUBLESHOOTING.md) - We'll be growing this file over time, with your help. Please make sure
+to document any issues you run into and [let us know](CONTACT_US.md).
+
+## More To Come!
+
+KaMP Kit is just the beginning. Our hope is that after KaMP Kit you’ll have a better sense of what a possible KMP implementation might look like.
+
+---
+
+### About Touchlab
+
+Touchlab is a mobile-focused development agency based in NYC. We have been working on Android since the beginning, and have worked on a wide range of mobile and hardware projects for the past decade. Over the past few years, we have invested significantly on R&D for code sharing technologies. We believe strongly in KMP's future and have made the Kotlin multiplatform the focus of our business.
+
+### About The Kit
+
+We talked to a few teams early on who got to do a "hack week" with KMP. A common story was, if they didn't abandon the project altogether, they didn't have anything running till the week was half over. Even then, picking libraries and architecture ate the rest of the time. Inevitably the result was, "KMP isn't ready". We know that once you're past the setup phase, KMP is really amazing tech. This Kit exists so you're evaluating KMP on Monday afternoon, not Thursday.
+
+### What We Can Do For You
+
+We have made KMP the focus of Touchlab. We had possibly the first KMP* app published in the iOS App Store, and have extensive experience in building libraries and the Kotlin platform, including contributions to Kotlin/Native itself. We can establish and accelerate your adoption of shared Kotlin code. See [touchlab.co](https://touchlab.co) for more info.
+
+> ## Subscribe!
+>
+> We build solutions that get teams started smoothly with Kotlin Multiplatform and ensure their success in production. Join our community to learn how your peers are adopting KMP.
+ [Sign up here](https://go.touchlab.co/newsletter)!
diff --git a/app/.gitignore b/app/.gitignore
new file mode 100644
index 0000000..796b96d
--- /dev/null
+++ b/app/.gitignore
@@ -0,0 +1 @@
+/build
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
new file mode 100644
index 0000000..5201d28
--- /dev/null
+++ b/app/build.gradle.kts
@@ -0,0 +1,52 @@
+plugins {
+ alias(libs.plugins.android.application)
+ alias(libs.plugins.kotlin.android)
+ alias(libs.plugins.compose.compiler)
+}
+
+android {
+ namespace = "co.touchlab.kampkit.android"
+ compileSdk = libs.versions.compileSdk.get().toInt()
+ defaultConfig {
+ applicationId = "co.touchlab.kampkit"
+ minSdk = libs.versions.minSdk.get().toInt()
+ targetSdk = libs.versions.targetSdk.get().toInt()
+ versionCode = 1
+ versionName = "1.0"
+ }
+
+ buildTypes {
+ getByName("release") {
+ isMinifyEnabled = false
+ proguardFiles(
+ getDefaultProguardFile("proguard-android-optimize.txt"),
+ "proguard-rules.pro"
+ )
+ }
+ }
+ compileOptions {
+ isCoreLibraryDesugaringEnabled = true
+ }
+ lint {
+ warningsAsErrors = false
+ abortOnError = true
+ }
+
+ buildFeatures {
+ compose = true
+ buildConfig = true
+ }
+}
+
+kotlin {
+ jvmToolchain(11)
+}
+
+dependencies {
+ implementation(projects.shared)
+ implementation(libs.bundles.app.ui)
+ implementation(libs.multiplatformSettings.common)
+ implementation(libs.kotlinx.dateTime)
+ coreLibraryDesugaring(libs.android.desugaring)
+ implementation(libs.koin.android)
+}
diff --git a/app/proguard-rules.pro b/app/proguard-rules.pro
new file mode 100644
index 0000000..f1b4245
--- /dev/null
+++ b/app/proguard-rules.pro
@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+# http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+# public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile
diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
new file mode 100644
index 0000000..8554e73
--- /dev/null
+++ b/app/src/main/AndroidManifest.xml
@@ -0,0 +1,27 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/app/src/main/kotlin/co/touchlab/kampkit/android/MainActivity.kt b/app/src/main/kotlin/co/touchlab/kampkit/android/MainActivity.kt
new file mode 100644
index 0000000..08ae095
--- /dev/null
+++ b/app/src/main/kotlin/co/touchlab/kampkit/android/MainActivity.kt
@@ -0,0 +1,27 @@
+package co.touchlab.kampkit.android
+
+import android.os.Bundle
+import androidx.activity.ComponentActivity
+import androidx.activity.compose.setContent
+import co.touchlab.kampkit.android.ui.MainScreen
+import co.touchlab.kampkit.android.ui.theme.KaMPKitTheme
+import co.touchlab.kampkit.injectLogger
+import co.touchlab.kampkit.models.BreedViewModel
+import co.touchlab.kermit.Logger
+import org.koin.androidx.viewmodel.ext.android.viewModel
+import org.koin.core.component.KoinComponent
+
+class MainActivity : ComponentActivity(), KoinComponent {
+
+ private val log: Logger by injectLogger("MainActivity")
+ private val viewModel: BreedViewModel by viewModel()
+
+ override fun onCreate(savedInstanceState: Bundle?) {
+ super.onCreate(savedInstanceState)
+ setContent {
+ KaMPKitTheme {
+ MainScreen(viewModel, log)
+ }
+ }
+ }
+}
diff --git a/app/src/main/kotlin/co/touchlab/kampkit/android/MainApp.kt b/app/src/main/kotlin/co/touchlab/kampkit/android/MainApp.kt
new file mode 100644
index 0000000..1875626
--- /dev/null
+++ b/app/src/main/kotlin/co/touchlab/kampkit/android/MainApp.kt
@@ -0,0 +1,39 @@
+package co.touchlab.kampkit.android
+
+import android.app.Application
+import android.content.Context
+import android.content.SharedPreferences
+import android.util.Log
+import co.touchlab.kampkit.AppInfo
+import co.touchlab.kampkit.initKoin
+import co.touchlab.kampkit.models.BreedViewModel
+import org.koin.androidx.viewmodel.dsl.viewModel
+import org.koin.core.parameter.parametersOf
+import org.koin.dsl.module
+
+class MainApp : Application() {
+
+ override fun onCreate() {
+ super.onCreate()
+ initKoin(
+ module {
+ single { this@MainApp }
+ viewModel { BreedViewModel(get(), get { parametersOf("BreedViewModel") }) }
+ single {
+ get().getSharedPreferences(
+ "KAMPSTARTER_SETTINGS",
+ Context.MODE_PRIVATE
+ )
+ }
+ single { AndroidAppInfo }
+ single {
+ { Log.i("Startup", "Hello from Android/Kotlin!") }
+ }
+ }
+ )
+ }
+}
+
+object AndroidAppInfo : AppInfo {
+ override val appId: String = BuildConfig.APPLICATION_ID
+}
diff --git a/app/src/main/kotlin/co/touchlab/kampkit/android/ui/Composables.kt b/app/src/main/kotlin/co/touchlab/kampkit/android/ui/Composables.kt
new file mode 100644
index 0000000..d92ef37
--- /dev/null
+++ b/app/src/main/kotlin/co/touchlab/kampkit/android/ui/Composables.kt
@@ -0,0 +1,214 @@
+package co.touchlab.kampkit.android.ui
+
+import androidx.compose.animation.Crossfade
+import androidx.compose.animation.core.FastOutSlowInEasing
+import androidx.compose.animation.core.TweenSpec
+import androidx.compose.foundation.Image
+import androidx.compose.foundation.clickable
+import androidx.compose.foundation.layout.Arrangement
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.Row
+import androidx.compose.foundation.layout.fillMaxSize
+import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.lazy.LazyColumn
+import androidx.compose.foundation.lazy.items
+import androidx.compose.foundation.rememberScrollState
+import androidx.compose.foundation.verticalScroll
+import androidx.compose.material.Divider
+import androidx.compose.material.ExperimentalMaterialApi
+import androidx.compose.material.MaterialTheme
+import androidx.compose.material.Surface
+import androidx.compose.material.Text
+import androidx.compose.material.pullrefresh.PullRefreshIndicator
+import androidx.compose.material.pullrefresh.pullRefresh
+import androidx.compose.material.pullrefresh.rememberPullRefreshState
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.rememberCoroutineScope
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.res.painterResource
+import androidx.compose.ui.res.stringResource
+import androidx.compose.ui.tooling.preview.Preview
+import androidx.compose.ui.unit.dp
+import androidx.lifecycle.compose.collectAsStateWithLifecycle
+import co.touchlab.kampkit.android.R
+import co.touchlab.kampkit.db.Breed
+import co.touchlab.kampkit.models.BreedViewModel
+import co.touchlab.kampkit.models.BreedViewState
+import co.touchlab.kermit.Logger
+import kotlinx.coroutines.launch
+
+@Composable
+fun MainScreen(viewModel: BreedViewModel, log: Logger) {
+ val dogsState by viewModel.breedState.collectAsStateWithLifecycle()
+ val scope = rememberCoroutineScope()
+
+ LaunchedEffect(viewModel) {
+ viewModel.activate()
+ }
+
+ MainScreenContent(
+ dogsState = dogsState,
+ onRefresh = { scope.launch { viewModel.refreshBreeds() } },
+ onSuccess = { data -> log.v { "View updating with ${data.size} breeds" } },
+ onError = { exception -> log.e { "Displaying error: $exception" } },
+ onFavorite = { scope.launch { viewModel.updateBreedFavorite(it) } }
+ )
+}
+
+@OptIn(ExperimentalMaterialApi::class)
+@Composable
+fun MainScreenContent(
+ dogsState: BreedViewState,
+ onRefresh: () -> Unit = {},
+ onSuccess: (List) -> Unit = {},
+ onError: (String) -> Unit = {},
+ onFavorite: (Breed) -> Unit = {}
+) {
+ Surface(
+ color = MaterialTheme.colors.background,
+ modifier = Modifier.fillMaxSize()
+ ) {
+ val refreshState = rememberPullRefreshState(dogsState.isLoading, onRefresh)
+
+ Box(Modifier.pullRefresh(refreshState)) {
+ when (dogsState) {
+ is BreedViewState.Empty -> Empty()
+ is BreedViewState.Content -> {
+ val breeds = dogsState.breeds
+ onSuccess(breeds)
+ Success(successData = breeds, favoriteBreed = onFavorite)
+ }
+
+ is BreedViewState.Error -> {
+ val error = dogsState.error
+ onError(error)
+ Error(error)
+ }
+
+ BreedViewState.Initial -> {
+ // no-op (just show spinner until first data is loaded)
+ }
+ }
+
+ PullRefreshIndicator(
+ dogsState.isLoading,
+ refreshState,
+ Modifier.align(Alignment.TopCenter)
+ )
+ }
+ }
+}
+
+@Composable
+fun Empty() {
+ Column(
+ modifier = Modifier
+ .fillMaxSize()
+ .verticalScroll(rememberScrollState()),
+ verticalArrangement = Arrangement.Center,
+ horizontalAlignment = Alignment.CenterHorizontally
+ ) {
+ Text(stringResource(R.string.empty_breeds))
+ }
+}
+
+@Composable
+fun Error(error: String) {
+ Column(
+ modifier = Modifier
+ .fillMaxSize()
+ .verticalScroll(rememberScrollState()),
+ verticalArrangement = Arrangement.Center,
+ horizontalAlignment = Alignment.CenterHorizontally
+ ) {
+ Text(text = error)
+ }
+}
+
+@Composable
+fun Success(successData: List, favoriteBreed: (Breed) -> Unit) {
+ DogList(breeds = successData, favoriteBreed)
+}
+
+@Composable
+fun DogList(breeds: List, onItemClick: (Breed) -> Unit) {
+ LazyColumn {
+ items(breeds) { breed ->
+ DogRow(breed) {
+ onItemClick(it)
+ }
+ Divider()
+ }
+ }
+}
+
+@Composable
+fun DogRow(breed: Breed, onClick: (Breed) -> Unit) {
+ Row(
+ Modifier
+ .clickable { onClick(breed) }
+ .padding(10.dp)
+ ) {
+ Text(breed.name, Modifier.weight(1F))
+ FavoriteIcon(breed)
+ }
+}
+
+@Composable
+fun FavoriteIcon(breed: Breed) {
+ Crossfade(
+ targetState = !breed.favorite,
+ animationSpec = TweenSpec(
+ durationMillis = 500,
+ easing = FastOutSlowInEasing
+ ),
+ label = "CrossFadeFavoriteIcon"
+ ) { fav ->
+ if (fav) {
+ Image(
+ painter = painterResource(id = R.drawable.ic_favorite_border_24px),
+ contentDescription = stringResource(R.string.favorite_breed, breed.name)
+ )
+ } else {
+ Image(
+ painter = painterResource(id = R.drawable.ic_favorite_24px),
+ contentDescription = stringResource(R.string.unfavorite_breed, breed.name)
+ )
+ }
+ }
+}
+
+@Preview
+@Composable
+fun MainScreenContentPreview_Success() {
+ MainScreenContent(
+ dogsState = BreedViewState.Content(
+ breeds = listOf(
+ Breed(0, "appenzeller", false),
+ Breed(1, "australian", true)
+ )
+ )
+ )
+}
+
+@Preview
+@Composable
+fun MainScreenContentPreview_Initial() {
+ MainScreenContent(dogsState = BreedViewState.Initial)
+}
+
+@Preview
+@Composable
+fun MainScreenContentPreview_Empty() {
+ MainScreenContent(dogsState = BreedViewState.Empty())
+}
+
+@Preview
+@Composable
+fun MainScreenContentPreview_Error() {
+ MainScreenContent(dogsState = BreedViewState.Error("Something went wrong!"))
+}
diff --git a/app/src/main/kotlin/co/touchlab/kampkit/android/ui/theme/Color.kt b/app/src/main/kotlin/co/touchlab/kampkit/android/ui/theme/Color.kt
new file mode 100644
index 0000000..287f01c
--- /dev/null
+++ b/app/src/main/kotlin/co/touchlab/kampkit/android/ui/theme/Color.kt
@@ -0,0 +1,8 @@
+package co.touchlab.kampkit.android.ui.theme
+
+import androidx.compose.ui.graphics.Color
+
+val Purple200 = Color(0xFFBB86FC)
+val Purple500 = Color(0xFF6200EE)
+val Purple700 = Color(0xFF3700B3)
+val Teal200 = Color(0xFF03DAC5)
diff --git a/app/src/main/kotlin/co/touchlab/kampkit/android/ui/theme/Shapes.kt b/app/src/main/kotlin/co/touchlab/kampkit/android/ui/theme/Shapes.kt
new file mode 100644
index 0000000..0260e33
--- /dev/null
+++ b/app/src/main/kotlin/co/touchlab/kampkit/android/ui/theme/Shapes.kt
@@ -0,0 +1,11 @@
+package co.touchlab.kampkit.android.ui.theme
+
+import androidx.compose.foundation.shape.RoundedCornerShape
+import androidx.compose.material.Shapes
+import androidx.compose.ui.unit.dp
+
+val Shapes = Shapes(
+ small = RoundedCornerShape(4.dp),
+ medium = RoundedCornerShape(4.dp),
+ large = RoundedCornerShape(0.dp)
+)
diff --git a/app/src/main/kotlin/co/touchlab/kampkit/android/ui/theme/Theme.kt b/app/src/main/kotlin/co/touchlab/kampkit/android/ui/theme/Theme.kt
new file mode 100644
index 0000000..0d0bf1f
--- /dev/null
+++ b/app/src/main/kotlin/co/touchlab/kampkit/android/ui/theme/Theme.kt
@@ -0,0 +1,44 @@
+package co.touchlab.kampkit.android.ui.theme
+
+import androidx.compose.foundation.isSystemInDarkTheme
+import androidx.compose.material.MaterialTheme
+import androidx.compose.material.darkColors
+import androidx.compose.material.lightColors
+import androidx.compose.runtime.Composable
+
+private val DarkColorPalette = darkColors(
+ primary = Purple200,
+ primaryVariant = Purple700,
+ secondary = Teal200
+)
+
+private val LightColorPalette = lightColors(
+ primary = Purple500,
+ primaryVariant = Purple700,
+ secondary = Teal200
+
+ // Other default colors to override
+ //
+ // background = Color.White,
+ // surface = Color.White,
+ // onPrimary = Color.White,
+ // onSecondary = Color.Black,
+ // onBackground = Color.Black,
+ // onSurface = Color.Black,
+)
+
+@Composable
+fun KaMPKitTheme(darkTheme: Boolean = isSystemInDarkTheme(), content: @Composable () -> Unit) {
+ val colors = if (darkTheme) {
+ DarkColorPalette
+ } else {
+ LightColorPalette
+ }
+
+ MaterialTheme(
+ colors = colors,
+ typography = Typography,
+ shapes = Shapes,
+ content = content
+ )
+}
diff --git a/app/src/main/kotlin/co/touchlab/kampkit/android/ui/theme/Typography.kt b/app/src/main/kotlin/co/touchlab/kampkit/android/ui/theme/Typography.kt
new file mode 100644
index 0000000..2c6faca
--- /dev/null
+++ b/app/src/main/kotlin/co/touchlab/kampkit/android/ui/theme/Typography.kt
@@ -0,0 +1,29 @@
+package co.touchlab.kampkit.android.ui.theme
+
+import androidx.compose.material.Typography
+import androidx.compose.ui.text.TextStyle
+import androidx.compose.ui.text.font.FontFamily
+import androidx.compose.ui.text.font.FontWeight
+import androidx.compose.ui.unit.sp
+
+// Set of Material typography styles to start with
+val Typography = Typography(
+ body1 = TextStyle(
+ fontFamily = FontFamily.Default,
+ fontWeight = FontWeight.Normal,
+ fontSize = 16.sp
+ )
+ // Other default text styles to override
+ //
+ // button = TextStyle(
+ // fontFamily = FontFamily.Default,
+ // fontWeight = FontWeight.W500,
+ // fontSize = 14.sp
+ // ),
+ //
+ // caption = TextStyle(
+ // fontFamily = FontFamily.Default,
+ // fontWeight = FontWeight.Normal,
+ // fontSize = 12.sp
+ // )
+)
diff --git a/app/src/main/res/drawable-v24/ic_launcher_foreground.xml b/app/src/main/res/drawable-v24/ic_launcher_foreground.xml
new file mode 100644
index 0000000..1f6bb29
--- /dev/null
+++ b/app/src/main/res/drawable-v24/ic_launcher_foreground.xml
@@ -0,0 +1,34 @@
+
+
+
+
+