jifffffy/FocusBloom

A Kotlin Multiplatform app that helps users enhance their productivity and time management skills through focused work intervals and short breaks.

FocusBloom

FocusBloom is a Kotlin Multiplatform app that helps users enhance their productivity and time management skills through focused work intervals and short breaks.

🛠️ WIP 🛠️

Please note that this project is still under development and some features may not work as expected.

If you find any bugs or have any suggestions, feel free to open an issue or a pull request.

Platforms

✅	✅	✅	Planned

Screenshots

Android

iOS

Desktop

Architecture

The app is shared between Android, iOS and Desktop. The shared code is written in Kotlin and the UI is built with Compose Multiplatform. Shared code, written in Kotlin, is compiled to JVM bytecode for Android and Desktop with Kotlin/JVM and to native binaries for iOS with Kotlin/Native.

Modules

• shared:
  • contains all the shared code between the platforms
• android:
  • contains the android app
• ios:
  • contains the ios app
• desktop:
  • contains the desktop app

Built with

• Kotlin Multiplatform - The Kotlin Multiplatform technology is designed to simplify the development of cross-platform projects.
• Compose Multiplatform - a modern UI framework for Kotlin that makes building performant and beautiful user interfaces easy and enjoyable.
• SQLDelight - SQLDelight is an open-source library developed by Cash App (formerly Square, Inc.) for working with SQL databases in Kotlin-based Android and multi-platform applications.
• Multiplatform Settings - A Kotlin Multiplatform library for saving simple key-value data.
• Koin - The pragmatic Kotlin & Kotlin Multiplatform Dependency Injection framework.
• Voyager - A multiplatform navigation library.
• Kotlinx-datetime - KotlinX multiplatform date/time library.
• Kotlinx-serilization - Kotlin multiplatform / multi-format serialization.
• Koala plot - Koala Plot is a Compose Multiplatform based charting and plotting library written in Kotlin.
• Compose Components Resources - Resources For Compose Multiplatform.
• Material3 Window Size Multiplatform - About Material 3 Window Size Class for Compose Multiplatform.
• Spotless - A code formatter that helps keep the codebase clean.
• Detekt - Static code analysis for Kotlin.
• Ktlint - A static code analysis tool and formatter for Kotlin.
• Github Actions - A CI/CD tool that helps automate workflows.
• Renovate - An open-source software tool designed to help automate the process of updating dependencies in software projects.

Run project

Android

To run the application on android device/emulator:

• open project in Android Studio and run imported android run configuration

Desktop

Run the desktop application: ./gradlew :desktop:run

iOS

To run the application on iPhone device/simulator:

• Open ios/iosApp.xcworkspace in Xcode and run standard configuration
• Or use Kotlin Multiplatform Mobile plugin for Android Studio

Todo

• Work on Notifications: To remind you of upcoming and overdue tasks
• Reminders: Sounds for breaks and work sessions
• Fix Calendar: it is not working as expected
• Add web platform: to enable users to use the app on the web
• Implement device synchronization: to enable users to sync their data across devices(Desktop, Android and iOS)
• Write tests

License

Copyright 2023 JoelKanyi

    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.