tyiuandClaude Sonnet 5
b856454df5
The module-layout bullets were still generic KMP-wizard boilerplate
("your project", a hypothetical CoreCrypto example never used here)
and omitted macOS, androidApp, desktopApp, and webApp entirely.
Replaces them with an accurate description of the actual layout.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FXcrACM5sok3M1KQJ8kByy
83 lines
3.9 KiB
Markdown
83 lines
3.9 KiB
Markdown
<img src="./docs/assets/satsprice-logo.png" alt="SatsPrice Logo" title="SatsPrice logo" width="256"/>
|
|
|
|
# SatsPrice
|
|
|
|
This app fetches the price of Bitcoin relative to common fiat currencies from multiple sources, and converts inputted amounts between Sats, BTC, and the selected fiat currency.
|
|
|
|
[](https://github.com/tyiu/sats-price/releases)
|
|
|
|
[](https://github.com/tyiu/sats-price)
|
|
[](/LICENSE)
|
|
|
|
## Download and Install
|
|
|
|
[<img src="./docs/assets/download_on_apple.svg"
|
|
alt="Download on the Apple App Store"
|
|
height="70">](https://apps.apple.com/app/satsprice/id6478230475)
|
|
[<img src="./docs/assets/download_on_zapstore.svg"
|
|
alt="Get it on Zap Store"
|
|
height="70">](https://github.com/zapstore/zapstore/releases)
|
|
[<img src="./docs/assets/download_on_obtainium.png"
|
|
alt="Get it on Obtaininum"
|
|
height="70">](https://github.com/ImranR98/Obtainium)
|
|
[<img src="./docs/assets/download_on_github.svg" alt="Get it on GitHub"
|
|
height="70">](https://github.com/tyiu/sats-price/releases)
|
|
|
|
## Supported Platforms
|
|
|
|
iOS 16.0+ • macOS 13.0+ • Android 7.0+
|
|
|
|
## Kotlin Multiplatform
|
|
|
|
This is a Kotlin Multiplatform project targeting Android, iOS, macOS, Web, and Desktop (JVM).
|
|
|
|
* [/shared](./shared/src) contains almost the entire app — UI (built with Compose Multiplatform),
|
|
view models, data sources, and domain logic. [commonMain](./shared/src/commonMain/kotlin) holds
|
|
code shared by every target, alongside platform-specific source sets: `androidMain`, `jvmMain`
|
|
(Desktop), `appleMain` (iOS and macOS), and `webMain` (JS and Wasm).
|
|
|
|
* [/androidApp](./androidApp), [/desktopApp](./desktopApp), and [/webApp](./webApp) are thin
|
|
launcher shells around `shared`'s Compose UI.
|
|
|
|
* [/iosApp](./iosApp/iosApp) is a native SwiftUI app (shared across iOS and macOS), not Compose —
|
|
it talks to `shared` through a hand-written bridge rather than rendering Compose directly.
|
|
|
|
### Running the apps
|
|
|
|
Use the run configurations provided by the run widget in your IDE's toolbar. You can also use these commands and
|
|
options:
|
|
|
|
- Android app: `./gradlew :androidApp:assembleDebug`
|
|
- Desktop app:
|
|
- Hot reload: `./gradlew :desktopApp:hotRun --auto`
|
|
- Standard run: `./gradlew :desktopApp:run`
|
|
- Web app:
|
|
- Wasm target (faster, modern browsers): `./gradlew :webApp:wasmJsBrowserDevelopmentRun`
|
|
- JS target (slower, supports older browsers): `./gradlew :webApp:jsBrowserDevelopmentRun`
|
|
- iOS app: open the [/iosApp](./iosApp) directory in Xcode and run it from there.
|
|
|
|
### Running tests
|
|
|
|
Use the run button in your IDE's editor gutter, or run tests using Gradle tasks:
|
|
|
|
- Android tests: `./gradlew :shared:testAndroidHostTest`
|
|
- Desktop tests: `./gradlew :shared:jvmTest`
|
|
- Web tests:
|
|
- Wasm target: `./gradlew :shared:wasmJsTest`
|
|
- JS target: `./gradlew :shared:jsTest`
|
|
- iOS tests: `./gradlew :shared:iosSimulatorArm64Test`
|
|
|
|
## Attribution
|
|
|
|
This project uses [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html),
|
|
[Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform/#compose-multiplatform), and
|
|
[Kotlin/Wasm](https://kotl.in/wasm/).
|
|
|
|
The [Bitcoin Calculator](https://www.flaticon.com/free-icons/bitcoin-calculator) icon was created by Icon home and licensed as free for personal and commercial use with attribution.
|
|
|
|
The following free APIs are used:
|
|
- Coinbase
|
|
- [Get Exchange Rates](https://docs.cdp.coinbase.com/coinbase-app/docs/api-exchange-rates#get-exchange-rates)
|
|
- [Get Spot Price](https://docs.cdp.coinbase.com/coinbase-app/docs/api-prices#get-spot-price)
|
|
- CoinGecko
|
|
- [Coin Price by IDs](https://docs.coingecko.com/reference/simple-price) |