š JetTaskBoardKMP ā Multiplatform Trello Clone
A clone of Trello app built using Compose Multiplatform for Android, iOS and Desktop.
This app was previously written in Jetpack Compose for Android inĀ JetTaskBoard. It is now re-written using multiplatform.
Application demo
JetTaskBoardKMP.mp4
āļø Architecture
JetTaskBoardKMP follows the principles of Clean Architecture.
šØāš» Tech stack
Tools | Link |
---|---|
š¤ Language | Kotlin |
š Framework | Compose Multiplatform |
š Lifecycle | Essenty |
š State Management | Decompose |
š Networking | KTor |
š Multi-threading | Kotlin Coroutines |
šŖ Persistence | Multiplatform Settings |
Special thanks toĀ xxfast/KRouterĀ library.
š„ļø Screenshots
How to run the project? ā
To run this project, you need the following:
- A machine running a recent version of macOS
- Xcode
- Android Studio
- TheĀ Kotlin Multiplatform Mobile plugin
- TheĀ CocoaPods dependency manager
Check your environment
Before you start, use theĀ KDoctorĀ tool to ensure that your development environment is configured correctly:
- Install KDoctor withĀ Homebrew:Ā
brew install kdoctor
- Run KDoctor in your terminal:Ā
kdoctor
If everything is set up correctly, youāll see valid output:Environment diagnose (to see all details, use -v option): [ā] Operation System [ā] Java [ā] Android Studio [ā] Xcode [ā] Cocoapods Conclusion: ā Your system is ready for Kotlin Multiplatform Mobile development!
Otherwise, KDoctor will highlight which parts of your setup still need to be configured and will suggest a way to fix them.
Understanding the project structure
Open the project in Android Studio and switch the view fromĀ AndroidĀ toĀ ProjectĀ to see all the files and targets belonging to the project:
Your Compose Multiplatform project includes 3 modules:
shared
This is a Kotlin module that contains the logic common for both Android and iOS applications, that is, the code you share between platforms.
ThisĀ shared
Ā module is also where youāll write your Compose Multiplatform code. InĀ shared/src/commonMain/kotlin/App.kt
, you can find the shared rootĀ @Composable
Ā function for your app.
It uses Gradle as the build system. You can add dependencies and change settings inĀ shared/build.gradle.kts
. TheĀ shared
Ā module builds into an Android library and an iOS framework.
androidApp
This is a Kotlin module that builds into an Android application. It uses Gradle as the build system. TheĀ androidApp
Ā module depends on and uses theĀ shared
Ā module as a regular Android library.
iosApp
This is an Xcode project that builds into an iOS application. It depends on and uses theĀ shared
Ā module as a CocoaPods dependency.
Run your application
On Android
To run your application on an Android emulator:
- Ensure you have an Android virtual device available. Otherwise,Ā create one.
- In the list of run configurations, selectĀ
androidApp
. - Choose your virtual device and clickĀ Run:
Alternatively, use Gradle
On iOS
Running on a simulator
To run your application on an iOS simulator in Android Studio, modify theĀ iosApp
Ā run configuration:
- In the list of run configurations, selectĀ Edit Configurations:
- Navigate toĀ iOS ApplicationĀ |Ā iosApp.
- In theĀ Execution targetĀ list, select your target device. ClickĀ OK.
- TheĀ
iosApp
Ā run configuration is now available. ClickĀ RunĀ next to your virtual device.
Running on a real device
You can run your Compose Multiplatform application on a real iOS device for free. To do so, youāll need the following:
- TheĀ
TEAM_ID
Ā associated with yourĀ Apple ID - The iOS device registered in Xcode
NoteĀ Before you continue, we suggest creating a simple āHello, world!ā project in Xcode to ensure you can successfully run apps on your device. You can follow the instructions below or watch thisĀ Stanford CS193P lecture recording.
How to create and run a simple project in Xcode
On Desktop
To run the application on desktop:
- Execute the command from terminal:Ā
./gradlew :shared:run
Find this project useful ? ā¤ļø
- Support it by clicking the āļø button on the upper right of this page. āļø
License
MIT License
Copyright (c) 2022 Pushpal Roy
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.