BeautifulZmanim
December 26, 2023 ยท View on GitHub
A multi-platform zmanim app that uses Google Material Design, written in Kotlin Multiplatform. Compiles to Android, iOS, web, and desktop (through the JVM). Based on Sternbach-Software's port of KosherJava: KosherKotlin
Future
Future supported platforms
- Android-based flip-phones
- WearOS
- watchOS
Future features
- Multi-platform way to get location instead of having to type in longitude and latitude
- Currently, existing libraries only support Android and iOS, not web and desktop:
Executables
Coming soon!
Building from source
Note: to build Apple platform targets, you must be using a Mac.
Before running!
- check your system with KDoctor
- install JDK 8 on your machine
- add
local.propertiesfile to the project root and set a path to Android SDK there - run
./gradlew podInstallin the project root
Android
To run the application on Android device/emulator:
- open project in Android Studio and run imported android run configuration
To build the application bundle:
- run
./gradlew :composeApp:assembleDebug - find
.apkfile incomposeApp/build/outputs/apk/debug/composeApp-debug.apk
Desktop
Run the desktop application: ./gradlew :composeApp:run
iOS
To run the application on an iPhone device/simulator:
- Open
iosApp/iosApp.xcworkspacein Xcode and run standard configuration - Or use Kotlin Multiplatform Mobile plugin for Android Studio
Browser
Run the browser application: ./gradlew :composeApp:jsBrowserDevelopmentRun
License
Licensed under the AGPL 3.0. One of the things this means is that if you use any code in this repository, you must make your code publicly available. It also means that you must state the modifications you made to the code. See the license for the full terms.