diff --git a/Fruitties/README.md b/Fruitties/README.md new file mode 100644 index 0000000..137b2a4 --- /dev/null +++ b/Fruitties/README.md @@ -0,0 +1,62 @@ +# Fruitties +Fruitties is a sample app using Kotlin Multiplatform built for Android with Jetpack Compose and iOS with SwiftUI. + +iOS screenshot +Android screenshot + +## Multiplatform Jetpack Libraries +This project integrates several Jetpack libraries that are KMP compatible: + +- [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) +- [Room](https://developer.android.com/kotlin/multiplatform/room) +- [DataStore](https://developer.android.com/kotlin/multiplatform/datastore) + +## Running the app + +We recommend installing the [Kotlin Multiplatform Plugin](https://plugins.jetbrains.com/plugin/14936-kotlin-multiplatform) to Android Studio. +This plugin offers several features to ease the development experience: + +- **New project wizard**: Create a new multiplatform project within the IDE. +- **Preflight checks**: Preflight checks help you configure your environment. +- **Run configurations**: Run, debug, and test applications on both iOS and + Android directly from the IDE. +- **Basic Swift support in the IDE**: Get basic Swift support in the IDE, + including cross-language debugging tools, navigation and quick + documentation. + +### Android + +1. Open the `Fruitties` project in Android Studio +2. Select the `androidApp` run configuration and run the app image + +### iOS + +With the [Kotlin Multiplatform Plugin](https://plugins.jetbrains.com/plugin/14936-kotlin-multiplatform) installed, you can run the app from Android Studio. + +1. Open the `Fruitties` project in Android Studio +2. Select the `iosApp` run configuration image + +#### Run with Xcode +Alternatively, you can open this project in Xcode and run it from there: + +1. Locate the `iosApp` within the `Fruitties` folder and open it with Finder image +2. Open the `iosApp.xcodeproj` image +3. Build and run the iOS app from Xcode by clicking the Run icon image + +## License + +``` +Copyright 2025 The Android Open Source Project + +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 + + https://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. +```