graph TD;
client-->android(android)
client-->ios(ios)
common-->client
common-->backend(backend)
submodule{submodule}
test
All the modules in the project are grouped into 6 targets:
android
, ios
and backend
are app modules that contains platform only codesclient
is a KMM module that shared between ios
and android
.common
is a KMP modules that shared between all the platforms (android
, ios
and backend
)submodule
these are different git repositories and can be used in any of these modules. (arrows are not shown for the sake of simplicity)test
contains test cases for architecture and coding conventionsThe project uses submodules, please clone it as below:
git clone https://github.com/CurrencyConverterCalculator/CCC.git &&
cd CCC &&
git submodule update --init --recursive
Submodules:
Be sure that you have latest Android Studio Canary build installed and XCode 13.0 or later.
Open CCC folder with Android Studio and select android:app
from configurations and run
Open CCC/ios/CCC.xcworkspace
with XCode after the packages are resolved you can run the project. Generally you should use the latest stable XCode version.
./gradlew :backend:run
After you run the app probably your all API calls will fail, it is expected since the private URLs are not shared publicly. If you want the test the app with real API calls, I have prepared a fake response. Please replace all the getConversion
methods in
com.oztechan.ccc.common.core.network.api.backend.BackendApiImpl
com.oztechan.ccc.common.core.network.api.premium.PremiumApiImpl
with below;
override suspend fun getConversion(base: String): ExchangeRate = client.get {
url {
takeFrom("https://gist.githubusercontent.com/mustafaozhan/fa6d05e65919085f871adc825accea46/raw/d3bf3a7771e872e0c39541fe23b4058f4ae24c41/response.json")
}
}.body()
graph TD;
subgraph Backend[Backend]
database(database) --> datasource
api(api) --> service
datasource --> Controller
service --> Controller
Controller --> App
end
subgraph Mobile[Mobile]
Persistence(Persistence) --> Storage
Database(Database) --> DataSource
API(API) --> Service
RemoteConfig(RemoteConfig) --> ConfigService
Storage --> ViewModel
DataSource --> ViewModel
Repository --> ViewModel
Storage --> Repository
DataSource --> Repository
Service --> Repository
ConfigService --> Repository
Service --> ViewModel
ConfigService --> ViewModel
ViewModel --> Views
end
Copyright 2017 Mustafa Ozhan
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.