tyiuandClaude Sonnet 5
188536867d
webHtmlApp is a new web build using Compose HTML instead of Compose Multiplatform UI's Skia/canvas renderer - real <select>/<input>/<button> elements, an anchored popup menu for reordering/removing currencies (Compose HTML has no built-in DropdownMenu), and locale-independent English strings (moko-resources' Compose integration pulls in compose.foundation/ui, which this module exists to avoid). Realizing the bundle-size win needed splitting sharedUi out of shared: the Compose Multiplatform Gradle plugin bundles Skiko's several-MB web runtime into any js/wasmJs target whose resolved dependencies contain org.jetbrains.compose.ui:ui anywhere, and shared previously declared it directly for the other (Skia-based) web app's UI. shared is now pure business/data logic with no Compose dependency; sharedUi holds App()/ PriceScreen() for androidApp, desktopApp, and webApp to render. PriceViewModel's ViewModel supertype and CurrencyConverter's BigDecimal params moved from implementation() to api() in shared, since they're part of its public surface that webHtmlApp now touches directly. Also drops the @js-joda/timezone dependency from both web builds: the app only ever calls TimeZone.currentSystemDefault(), which resolves to a synthetic zone backed by the native Date offset on Kotlin/JS and never touches the tz database - confirmed empirically on both js and wasmJs targets. Cuts webApp's js bundle by ~950 KB and webHtmlApp's by ~800 KB. currencyFlagEmoji() gained an explicit supportsFlagEmoji parameter (defaulting to the existing expect/actual, false on web) so webHtmlApp can opt in - Compose HTML renders real DOM text, so flag emoji work fine there even though they don't on Compose Multiplatform's canvas. website/serve-local.sh now builds and serves webHtmlApp instead of webApp's wasmJs build, so it no longer mirrors what's actually deployed to production; docs updated to reflect the new module layout and that divergence, and the Pages workflow's path trigger now includes sharedUi/** so UI changes there still redeploy the site. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
115 lines
7.3 KiB
Markdown
115 lines
7.3 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.
|
|
|
|
**[satsprice.app Website](https://satsprice.app)**
|
|
|
|
[](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 App Store"
|
|
height="70">](https://apps.apple.com/app/satsprice/id6478230475)
|
|
[<img src="./docs/assets/get-it-on-zapstore.svg"
|
|
alt="Get it on Zap Store"
|
|
height="70">](https://zapstore.dev/apps/xyz.tyiu.SatsPrice)
|
|
[<img src="./docs/assets/download_on_obtainium.png"
|
|
alt="Get it on Obtaininum"
|
|
height="70">](https://github.com/ImranR98/Obtainium)
|
|
[<img src="./docs/assets/badge_github.png" 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+ • [Web](https://satsprice.app/app/) (any modern browser)
|
|
|
|
## Screenshots
|
|
|
|
### Android
|
|
|
|
<img src="./docs/assets/screenshots/android/android-1.png" width="200"> <img src="./docs/assets/screenshots/android/android-2.png" width="200"> <img src="./docs/assets/screenshots/android/android-3.png" width="200"> <img src="./docs/assets/screenshots/android/android-4.png" width="200"> <img src="./docs/assets/screenshots/android/android-5.png" width="200"> <img src="./docs/assets/screenshots/android/android-6.png" width="200"> <img src="./docs/assets/screenshots/android/android-7.png" width="200"> <img src="./docs/assets/screenshots/android/android-8.png" width="200">
|
|
|
|
### iPhone
|
|
|
|
<img src="./docs/assets/screenshots/iphone/iphone-1.png" width="200"> <img src="./docs/assets/screenshots/iphone/iphone-2.png" width="200"> <img src="./docs/assets/screenshots/iphone/iphone-3.png" width="200"> <img src="./docs/assets/screenshots/iphone/iphone-4.png" width="200"> <img src="./docs/assets/screenshots/iphone/iphone-5.png" width="200"> <img src="./docs/assets/screenshots/iphone/iphone-6.png" width="200"> <img src="./docs/assets/screenshots/iphone/iphone-7.png" width="200"> <img src="./docs/assets/screenshots/iphone/iphone-8.png" width="200">
|
|
|
|
### iPad
|
|
|
|
<img src="./docs/assets/screenshots/ipad/ipad-1.png" width="320"> <img src="./docs/assets/screenshots/ipad/ipad-2.png" width="320"> <img src="./docs/assets/screenshots/ipad/ipad-3.png" width="320"> <img src="./docs/assets/screenshots/ipad/ipad-4.png" width="320"> <img src="./docs/assets/screenshots/ipad/ipad-5.png" width="320"> <img src="./docs/assets/screenshots/ipad/ipad-6.png" width="320"> <img src="./docs/assets/screenshots/ipad/ipad-7.png" width="320"> <img src="./docs/assets/screenshots/ipad/ipad-8.png" width="320">
|
|
|
|
### macOS
|
|
|
|
<img src="./docs/assets/screenshots/macos/macos-1.png" width="320"> <img src="./docs/assets/screenshots/macos/macos-2.png" width="320"> <img src="./docs/assets/screenshots/macos/macos-3.png" width="320"> <img src="./docs/assets/screenshots/macos/macos-4.png" width="320"> <img src="./docs/assets/screenshots/macos/macos-5.png" width="320"> <img src="./docs/assets/screenshots/macos/macos-6.png" width="320">
|
|
|
|
## 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 (Compose Multiplatform UI, Skia-rendered - what's deployed to production):
|
|
- Wasm target (faster, modern browsers): `./gradlew :webApp:wasmJsBrowserDevelopmentRun`
|
|
- JS target (slower, supports older browsers): `./gradlew :webApp:jsBrowserDevelopmentRun`
|
|
- Web app, DOM alternative (Compose HTML UI, renders real DOM instead of Skia/canvas - not what's
|
|
deployed to production): `./gradlew :webHtmlApp:jsBrowserDevelopmentRun`
|
|
- iOS app: open the [/iosApp](./iosApp) directory in Xcode and run it from there.
|
|
- [Website](./website) with the web app built and served at `/app/` (the `webHtmlApp` DOM build,
|
|
not the one production actually deploys): `./website/serve-local.sh` (serves at
|
|
http://localhost:8000 by default; pass a port number to override)
|
|
|
|
### 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/), along with the following libraries:
|
|
|
|
- [Ktor](https://github.com/ktorio/ktor) for networking
|
|
- [SQLDelight](https://github.com/cashapp/sqldelight) for local persistence
|
|
- [moko-resources](https://github.com/icerockdev/moko-resources) for multiplatform string/resource handling
|
|
- [kotlinx.coroutines](https://github.com/Kotlin/kotlinx.coroutines), [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization), and [kotlinx.datetime](https://github.com/Kotlin/kotlinx-datetime)
|
|
- [kotlin-wrappers](https://github.com/JetBrains/kotlin-wrappers) for browser/JS interop on the Web target
|
|
- [kotlin-multiplatform-bignum](https://github.com/ionspin/kotlin-multiplatform-bignum) for arbitrary-precision arithmetic
|
|
|
|
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) |