Improve project architecture

[SuhasDissa]

.
├── App.kt
├── data
│   └── database
│       ├── AppDatabase.kt
│       ├── dao
│       │   ├── AlarmsDao.kt
│       │   ├── Converters.kt
│       │   └── TimeZonesDao.kt
│       └── DatabaseHolder.kt
├── domain
│   └── model
│       ├── AlarmFilters.kt
│       ├── Alarm.kt
│       ├── CountryTimezone.kt
│       ├── NumberKeypadOperation.kt
│       ├── PersistentTimer.kt
│       ├── ScheduledObject.kt
│       ├── SortOrder.kt
│       ├── TimeObject.kt
│       ├── TimeUnit.kt
│       ├── TimeZone.kt
│       └── WatchState.kt
├── navigation
│   ├── NavContainer.kt
│   ├── NavHost.kt
│   ├── NavRoutes.kt
│   └── TopBarScaffold.kt
├── presentation
│   ├── components
│   │   ├── BlobIconBox.kt
│   │   ├── ClickableIcon.kt
│   │   ├── DialogButton.kt
│   │   ├── DisabledTextField.kt
│   │   ├── SwitchWithDivider.kt
│   │   └── TimePickerDial.kt
│   ├── features
│   │   ├── AlarmReceiverDialog.kt
│   │   ├── RingtonePickerDialog.kt
│   │   └── TimerReceiverDialog.kt
│   ├── screens
│   │   ├── alarm
│   │   │   ├── AlarmActivity.kt
│   │   │   ├── AlarmAlertScreen.kt
│   │   │   ├── AlarmScreen.kt
│   │   │   ├── components
│   │   │   │   ├── AlarmFilterSection.kt
│   │   │   │   ├── AlarmRow.kt
│   │   │   │   ├── AlarmSettingsSheet.kt
│   │   │   │   ├── AlarmTimePicker.kt
│   │   │   │   ├── SnoozeTimePickerDialog.kt
│   │   │   │   └── TimePickerDialog.kt
│   │   │   └── model
│   │   │       └── AlarmModel.kt
│   │   ├── clock
│   │   │   ├── ClockScreen.kt
│   │   │   └── model
│   │   │       └── ClockModel.kt
│   │   ├── settings
│   │   │   ├── components
│   │   │   │   ├── ButtonGroupPref.kt
│   │   │   │   ├── ColorPref.kt
│   │   │   │   ├── IconPreference.kt
│   │   │   │   ├── PreferenceItem.kt
│   │   │   │   ├── SettingsCategory.kt
│   │   │   │   └── SwitchPref.kt
│   │   │   ├── model
│   │   │   │   └── SettingsModel.kt
│   │   │   └── SettingsScreen.kt
│   │   ├── stopwatch
│   │   │   ├── model
│   │   │   │   └── StopwatchModel.kt
│   │   │   └── StopwatchScreen.kt
│   │   └── timer
│   │       ├── components
│   │       │   ├── FormattedTimerTime.kt
│   │       │   ├── KeyboardTimePicker.kt
│   │       │   ├── NumberKeypad.kt
│   │       │   ├── ScrollTimePicker.kt
│   │       │   ├── SingleElementButton.kt
│   │       │   └── TimerItem.kt
│   │       ├── model
│   │       │   ├── RingingToneModel.kt
│   │       │   └── TimerModel.kt
│   │       └── TimerScreen.kt
│   └── widgets
│       ├── AnalogClockWidget.kt
│       ├── DigitalClockWidgetConfig.kt
│       ├── DigitalClockWidget.kt
│       └── VerticalClockWidget.kt
├── ui
│   ├── MainActivity.kt
│   └── theme
│       ├── Color.kt
│       ├── Theme.kt
│       └── Type.kt
└── util
    ├── AlarmHelper.kt
    ├── extensions
    │   ├── AddZero.kt
    │   ├── Context.kt
    │   ├── KeepScreenOn.kt
    │   └── ModifierExtension.kt
    ├── IntentHelper.kt
    ├── NotificationHelper.kt
    ├── PermissionHelper.kt
    ├── PickPersistentFileContract.kt
    ├── Preferences.kt
    ├── receivers
    │   ├── AlarmReceiver.kt
    │   └── BootReceiver.kt
    ├── RingtoneHelper.kt
    ├── services
    │   ├── AlarmService.kt
    │   ├── ScheduleService.kt
    │   ├── StopwatchService.kt
    │   └── TimerService.kt
    ├── ThemeUtil.kt
    ├── TimeHelper.kt
    └── TimezoneHelper.kt

[SuhasDissa]

Proposal: Change project structure to improve code readability and maintenance

Use three main directories to store code according to it's use case

• data : Databases or any other data sources
• domain : The link between data source and UI, Store repositories and data classes here
• presentation : The user presentable parts of the app

Categorize UI components according to screens

• Use the presentation directory to store all the user presented components.
• This can be further categorized into:

  • screens : screens with their own navigation destination
  • widgets : home screen widgets
  • components : simple composables that are being used by multiple screens
  • features : more complex composables that can't be considered as screens ( dialogs, bottom sheets)

• Create directories for each screen and store all the related components and viewmodels under that

  This will make it easier to locate components used by each screen

  Make the code simple and easy to read

• Make a screen as simple as possible by dividing it into self explanatory composable functions. for example:

  @Composable
  fun ClockScreen(){
  Column{
      CurrentTimeDisplay()
      WorldClockList()
  }
  }

• Make sure each viewModel is used only by one screen

  This will help prevent any unexpected behavior when navigating

• Avoid passing viewModels into smaller components and use function parameters and callbacks.

  Makes it easy to test and preview the components. Makes the components re-usable

  ---

  This is what I personally suggest. If you have any other ideas please let me know. I completed only the first two steps in this PR