KMP

.fleet/receipt.json

@@ -0,0 +1,24 @@
+// Project generated by Kotlin Multiplatform Wizard
+{
+    "spec": {
+        "template_id": "kmt",
+        "targets": {
+            "android": {
+                "ui": [
+                    "compose"
+                ]
+            },
+            "ios": {
+                "ui": [
+                    "compose"
+                ]
+            },
+            "desktop": {
+                "ui": [
+                    "compose"
+                ]
+            }
+        }
+    },
+    "timestamp": "2023-12-03T19:28:10.118100282Z"
+}

.gitignore

@@ -85,3 +85,11 @@ lint/generated/
 lint/outputs/
 lint/tmp/
 # lint/reports/
+
+.cxx
+*.xcodeproj/*
+!*.xcodeproj/project.pbxproj
+!*.xcodeproj/xcshareddata/
+!*.xcodeproj/project.xcworkspace/
+!*.xcworkspace/contents.xcworkspacedata
+**/xcshareddata/WorkspaceSettings.xcsettings

README.md

@@ -1,85 +1,14 @@
-# ![launcher icon](logo.png) Rick and Morty [![Actions Status](https://github.com/mohsenoid/Rick-and-Morty/workflows/Android%20CI/badge.svg)](https://github.com/mohsenoid/Rick-and-Morty/actions) [![codecov](https://codecov.io/gh/mohsenoid/Rick-and-Morty/branch/master/graph/badge.svg)](https://codecov.io/gh/mohsenoid/Rick-and-Morty) [![CodeFactor](https://www.codefactor.io/repository/github/mohsenoid/rick-and-morty/badge)](https://www.codefactor.io/repository/github/mohsenoid/rick-and-morty)
+This is a Kotlin Multiplatform project targeting Android, iOS, Desktop.
 
-This repository contains Rick and Morty Android application which I am using as training material.
+* `/composeApp` is for code that will be shared across your Compose Multiplatform applications.
+  It contains several subfolders:
+  - `commonMain` is for code that’s common for all targets.
+  - Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name.
+    For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app,
+    `iosMain` would be the right folder for such calls.
 
-![Screenshot](SCREENSHOT1.png) ![Screenshot](SCREENSHOT2.png)
+* `/iosApp` contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform, 
+  you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project.
 
-## User Stories
 
-1. The first thing a user should see is a list of episodes.
-2. If the user taps into an episode the app has to display a list of characters with a clear distinction between dead and alive characters
-3. If the user taps into a character the app has to display that character's picture and information.
-4. The user should have the ability to kill a character and if a character gets killed the character lists should update accordingly
-
-## Functionality
-
-The app is composed of 3 main screens:
-
-### Episodes List
-
-It allows you to list episodes in pages. Network results are kept in the database in the `episodes` table. Each time a new page is fetched, the same `episode` record in the database is updated with the new data.
-
-### Episode's Characters List
-
-Shows you the list of episode characters. Network results are also kept in the database in the `characters table`. Each time a new character is fetched, the same `character` record in the database is updated with the new data and we make sure we don't override *is killed by user* data.
-
-### Character Details
-
-This screen displays the details of a character and if *is killed by the user*.
-
-## Building
-
-You can clone and open the project in Android studio and press run!
-
-## Testing
-
-The project uses local unit tests that run on your computer. To run those tests and generate a coverage report, you can run:
-
-	./gradlew jacocoReport
-
-***NOTE:*** You can find the tests report in `app/build/reports/jacoco/jacocoReport/html/index.html` 
-
-## Technical details
-
-The Application implemented and structured based on **Clean Architecture** and **SOLID** principles best practices and the presentation layer is implemented based on the **MVP** pattern.
-
-The **Data** layer contains **Network Client** implemented by *Retrofit* library to get access to remote data on [Rick And Morty API](https://rickandmortyapi.com/) and **DB** implemented by *Room* library to cache and persist those data locally in case of offline usage.
-
-The **Domain** layer consists of a **Repository** which allows access to the Data layer. It also uses *Kotlin Coroutines* **IO** and **Main** *dispatchers* to execute long-running tasks in the background and reflect the result on UI. There is also a **Test** *dispatcher* that executes tasks immediately on the same unit test thread.
-
-![Repository Pattern](REPOSITORY_PATTERN.png)
-
-The **View** layer is done with the [Android Navigation Component](https://developer.android.com/guide/navigation) including one MainActivity which holds the navigation host fragment and 3 different Fragments which uses their contract interfaces to implement the *view* and *presenter* for responding to user interactions.
-
-![Navigation Graph](NAV_GRAPH.png)
-
-The **Koin** library does the *dependency injections* in the whole app. It also uses **Base** objects to define scopes and inject dependencies into **Activities** and **Fragments**.
-
-[**GitHub Actions CI service**](https://github.com/mohsenoid/Rick-and-Morty/actions) is running the repo tests and build Gradle tasks and **jacoco** plugin generates and submits the code coverage reports to [**codecov.io**](https://codecov.io/gh/mohsenoid/Rick-and-Morty).
-
-Code is covered by unit tests implemented using **Mockito** and **Kluent**. Also, some Android tests using **Robolectric**.
-
-## Libraries
-
-- **Timber** logger library made by [Jake Wharton](https://github.com/JakeWharton/timber)
-- **Picasso** image downloading and caching library made by [square](https://github.com/square/picasso)
-- **Retrofit** and **OkHttp** API libraries made by [square](https://github.com/square/retrofit)
-- **Kotlin Serialization** plugin made by [jetbrains](https://github.com/Kotlin/kotlinx.serialization)
-- **Koin** dependency injector library made by [InsertKoinIO](https://github.com/InsertKoinIO/koin)
-- **Kluent** assertions library made by [MarkusAmshove](https://github.com/MarkusAmshove/Kluent)
-
-### References
-
-- App **Launcher Icon** made by [freepngimg.com](http://freepngimg.com)
-
-- **Dead/Alive Icons** made by [Freepik](https://flaticon.com/authors/freepik) from [flaticon.com](https://flaticon.com)
-
-## License 
-
-Copyright 2020 Mohsen Mirhoseini Argi
-
-Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you 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.
+Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html)…