Light

sternbach-software / beautifulzmanim Goto Github PK

View Code? Open in Web Editor NEW

1.0 2.0 0.0 183.53 MB

A multi-platform zmanim app that uses Google Material Design, written in Kotlin Multiplatform. Compiles to Android, iOS, web, and desktop (through the JVM).

License: GNU Affero General Public License v3.0

Kotlin 53.50% HTML 0.12% Swift 0.03% Java 46.32% JavaScript 0.03%

compose-desktop compose-multiplatform compose-ui jetpack-compose kmm-app kotlin kotlin-multiplatform multiplatform zman zmanim

beautifulzmanim's Introduction

BeautifulZmanim

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:
  - https://github.com/line/abc-kmm-location
  - https://github.com/icerockdev/moko-geo

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.properties file to the project root and set a path to Android SDK there
run ./gradlew podInstall in 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 .apk file in composeApp/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.xcworkspace in 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.

beautifulzmanim's People

Contributors

Stargazers

Watchers

beautifulzmanim's Issues

Chametz zmanim all year?

Shouldn't zmanim related to chametz return null when it isn't erev pesach?

Here's how I would do this if you where rebuilding in Kotlin

Have a sealed class of Special Zmanim (or another name) that is returned in a list
so each day has

ZmanimForToday {
all the regular fields, date, sunrise, sunset...
List {
CandleLighting, Chametz, Fasting....
}
}

that way the api can just add or omit items to the list for the given day (fast days, chametz, etc..) and the UI side of things can just render the data directly from the api

in a nutshell, the UI should not have to know or care about the specifics for the given day, it should just render whatever is returned from the api for that day

taking this further, there can be a Configuration class (for things like InIsrael) which is used to initialize the zmanim "engine"

This way you pass the settings in once and create your engine which drives the UI

Dynamic color theme?

replacing this code in Theme.kt

val colors = if (!useDarkTheme) {
    LightColorScheme
} else {
    DarkColorScheme
}

with that

val dynamicColor = Build.VERSION.SDK_INT >= Build.VERSION_CODES.S
val colors = when {
    dynamicColor && useDarkTheme -> dynamicDarkColorScheme(LocalContext.current)
    dynamicColor && !useDarkTheme -> dynamicLightColorScheme(LocalContext.current)
    useDarkTheme -> DarkColors
    else -> LightColors
}

allows the app to use Material 3 Dynamic color and i think that can help a lot.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.