-
Notifications
You must be signed in to change notification settings - Fork 108
Create README.md #89
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Create README.md #89
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# Fruitties | ||
Fruitties is a sample app using Kotlin Multiplatform built for Android with Jetpack Compose and iOS with SwiftUI. | ||
|
||
<img width="45%" alt="iOS screenshot" src="https://github.com/user-attachments/assets/0bbbe6cc-c992-40c8-8759-08689ff0a900" /> | ||
<img width="45%" alt="Android screenshot" src="https://github.com/user-attachments/assets/8e0af83a-204f-4d16-874b-79a4bc871c43" /> | ||
|
||
## 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 <img width="557" height="122" alt="image" src="https://github.com/user-attachments/assets/54019a6a-6877-421a-b195-ddfaf7e4a721" /> | ||
|
||
### 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 <img width="623" height="103" alt="image" src="https://github.com/user-attachments/assets/56ff4eb7-f45a-4043-8aca-9733cb59d053" /> | ||
|
||
#### 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 <img width="762" height="579" alt="image" src="https://github.com/user-attachments/assets/3bdc2dd3-bb01-47b1-81c0-e8e1c0f43991" /> | ||
2. Open the `iosApp.xcodeproj` <img width="192" height="103" alt="image" src="https://github.com/user-attachments/assets/a933eb69-7d71-44b5-aff0-adcf7931f2db" /> | ||
3. Build and run the iOS app from Xcode by clicking the Run icon <img width="243" height="42" alt="image" src="https://github.com/user-attachments/assets/a278e57a-7d13-4299-94a8-01ffd6e9e89f" /> | ||
|
||
## 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. | ||
``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.