Skip to content

A Jetpack Compose clock app with timer, stopwatch and one-time/recurring alarms.

License

Notifications You must be signed in to change notification settings

yassineAbou/Clock

Repository files navigation

Weather

Clock

Kotlin version 1.8.21 Gradle version 8.0.2 Android Studio Flamingo Android min version 7

Presenting a clock app which was totally made in Jetpack Compose! You can use this app's timer and stopwatch functions, which are linked to workManager. The animation is added to the app to increase engagement. Also, you can create one time and recurring alarms and edit, enable, and disable them.

Get it on Google Play Get it on IzzyOnDroid

Screenshots

Features

For full clock app functionality, permissions vary by Android version:

  • On Android 13+, grant notification permission for alarm, timer, and stopwatch alerts.
  • On Android 12, If SCHEDULE_EXACT_ALARM isn't allowed, a dialog appears. Click "Ok" to be guided to the app settings where you can manually grant the permission.

Architecture

The architecture of this application relies and complies with the following points below:

  • A single-activity architecture, using the compose navigation to navigate between composables that are connected with the bottom navigation component
  • Pattern Model-View-ViewModel(MVVM) which facilitates a separation of development of the graphical user interface.
  • Android architecture components which help to keep the application robust, testable, and maintainable.

Package Structure

com.yassineabou.clock        # Root Package
├── data                 # For data operations
│   ├── local            # Handling local data
|   ├── manager          # Managing data operations
│   ├── model            # Data models
│   ├── receiver         # For receiving broadcasts
│   ├── repository       # Single source for data
│   └── workManager      # Handles background tasks
│       ├── factory      # For creating worker instances
│       └── worker       # Background task definitions
|  
├── di                   # Dependency Injection: Manages dependencies
│  
├── ui                   # UI Layer: Activity, Screens, ViewModels
│   ├── alarm            # Manages alarm functionalities
|   ├── stopwatch        # Manages stopwatch functionalities
|   ├── theme            # Handles app theme preferences
|   ├── timer            # Manages timer functionalities
|   ├── MainActivity     # Main activity hosting all fragments
│   └── Screen           # Manages different screens
|  
├── utils                # Utility Classes / Kotlin extensions for reusability
│   ├── components       # Reusable UI components
│   ├── helper           # Provides helper methods
|   ├── Extensions       # Kotlin extension functions
│   └── GlobalProperties # Global properties used across the app
└── ClockApplication     # Application class for global settings

Built With 🧰

Contribution

We welcome contributions to our project! Please follow these guidelines when submitting changes:

  • Report bugs and feature requests by creating an issue on our GitHub repository.
  • Contribute code changes by forking the repository and creating a new branch.
  • Ensure your code follows our coding conventions.
  • Improve our documentation by submitting changes as a pull request.

Thank you for your interest in contributing to our project!

License

Copyright 2023 Yassine Abou 
  
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.