<br /> <div align="center"> <a href="https://github.com/othneildrew/Best-README-Template"> <img src="./readme-assets/screenshots/stev_logo.png" alt="Logo" width="80" height="80"> </a> <h1 align = "center"> <b><i>DiaryApp</i></b> </h1> <p align="center"> Complete Multi-Modular Android App <br />

Screenshots ~ Deployment ~ Architecture ~ Tech Stack ~ Authors ~ Contributing
License

</div>

DiaryApp is a modern project written in Kotlin and powered by Jetpack Compose. It allows users to write and save diary entries with the option to include photos and expressive emojis to capture the essence of each moment.

Start documenting your life's moments with the Android Diary App today!

:camera_flash: Screenshots :camera_flash:

DiaryApp follows the latest Material 3 guidelines for a visually appealing and a consistent UI.

<p align="center"> <img img width="200" height="400" src="./readme-assets/screenshots/screen_1.png"> &nbsp;&nbsp;&nbsp;&nbsp; <img img width="200" height="400" src="./readme-assets/screenshots/screen_2.png"> &nbsp;&nbsp;&nbsp;&nbsp; <img img width="200" height="400" src="./readme-assets/screenshots/screen_3.png"> &nbsp;&nbsp;&nbsp;&nbsp; </p>

:arrow_lower_right: Deployment :arrow_lower_right:

These are the key parameters for Diary Project.

| Parameter | Value | |----------------|-------| | compileSdk | 33 | | targetSdk | 33 | | minSdk | 24 | | composeVersion | 1.5.0-beta01 | | kotlinVersion | 1.8.10 |

You can clone the repository or download the Zip file here.

To build and run the app, you will need the latest version of Android Studio Flamingo (or newer) installed on your system.

:hammer_and_wrench: Architecture :hammer_and_wrench:

Modules

DiaryApp is built using Multi-Module Architecture with layered features.

Here's an overview of the app's architectural modular components:

• App Module: This is the main module of the DiaryApp, whhich acts as the orchestrator of the different features and modules. It handles the navigation flow between the Authentication, Home, and the Write features, ensuring a cohesive and seamless user experience. The App Module integrates the dependencies from the feature modules and manages the overall lifecycle of the app.

• buildSrc: The buildSrc module serves as a central location for managing project configuration and dependencies. This module allows for a streamlined and standardized setup of project configurations, build scripts, and dependencies, simplifying the build process and ensuring consistency across the app.

• Data Module:The Data module in the Android Diary App is responsible for managing data storage and retrieval using both MongoDB and Room. It handles the setup and integration of Mongo Realm, allowing seamless connectivity to the MongoDB backend. The Data module provides functionalities for inserting, fetching, updating, and deleting diary entries in the MongoDB database. Additionally, DiaryApp leverages Room Librayto provide offline access and local caching of diary entries, enhancing the app's responsiveness and offline capabilities.

• Common/Core Modules: The app includes two core modules: UI and Utils. The UI module contains common Compose functions, components, and UI-related code that are shared across different features. This module promotes code reuse and consistency in the app's user interface. The Utils module provides essential utilities such as model classes, connectivity observers, constants, strings and drawable resources. It ensures a centralized and efficient management of commonly used resources and functionalities.

Navigation

The app has :three: screen destinations which use Compose Destinations Library ( See Issue 434 ) to manage navigation.

| :feature:auth | :feature:home | :feature:write | |-------------------------------------|-------------------------------------|-------------------------------------| | | | |

• Authentication Feature: This feature focuses on user authentication and validation. It utilizes Google Sign-In to ensure that users can securely access their diary entries. By authenticating users, the app guarantees that only authorized individuals can interact with their personal diaries.

• Home Feature: The Home feature is responsible for displaying and filtering diary entries based on the date. It provides a user-friendly interface to navigate through diary entries and quickly filter diaries by specific dates. Additional selections can be accessed through the Navigation Drawer.

• Write Feature: The Write feature enables users to create new diary entries or modify existing ones. It offers a seamless and intuitive interface for users to capture and document their thoughts, moments, and memories. DiaryApp empowers the users to personalize content by adding emojis and accompanying images

Overroll by adopting a multi-modular architecture with layered features, the Diary app achieves a separation of concerns, enabling independent development and testing of specific functionalities. This architecture promotes code reusability, scalability and easy maintainability

:building_construction: Tech Stack :building_construction:

The Diary project uses many popular libraries and tools in the Android Ecosystem:

• Jetpack Compose - modern toolkit for building native Android UI.

• Android KTX - helps to write more concise, idiomatic Kotlin code.

• Coroutines and Kotlin Flow - used to manage the local storage i.e. writing to and reading from the database. Coroutines help in managing background threads and reduces the need for callbacks.

• Material Design 3 - an adaptable system of guidelines, components, and tools that support the best practices of user interface design.

• Compose Destinations - used to handle all navigations and arguments passing while hiding the complex, non-type-safe and boilerplate code

• Google Accompanist Libraries - these are a collection of extension libraries for Jetpack Compose. DiaryApp specifically uses Accompanist's Pager Library

• Dagger Hilt - used for Dependency Injection.

• Coil - an image loading library for Android backed by Kotlin Coroutines

• SplashScreen API - SplashScreen API lets apps launch with animation, including an into-app motion at launch, a splash screen showing your app icon, and a transition to your app itself.

• Room persistence library which provides an abstraction layer over SQLite to allow for more robust database access while harnessing the full power of SQLite.

• Mongo - MongoDB is a popular NoSQL database, used in this app for storing and managing data related to diary entries.

• Firebase Storage - Firebase Cloud Storage is a scalable and reliable cloud storage solution used in the app for storing and retrieving photos associated with diary entries.

• Firebase Auth - Firebase Authentication provides a secure and easy-to-use authentication system, allowing users to sign in and access their diary entries securely.

• Max Keppeler's Sheet Compose Dialog - Firebase Authentication provides a secure and easy-to-use authentication system, allowing users to sign in and access their diary entries securely.

• StevDza-San's MessageBarCompose - Animated Message Bar UI that can be wrapped around your screen content in order to display Error/Success messages in your app. It is adapted and optimized for use with Compose and Material 3 projects.

• StevDza-San's OneTapCompose - Animated Message Bar UI that can be wrapped around your screen content in order to display Error/Success messages in your app. It is adapted and optimized for use with Compose and Material 3 projects.

:memo: Authors :memo:

• @Tonnie-Dev

Do Reach Out :

• Twitter

<a href="https://www.buymeacoffee.com/AgVrgB4N3r" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>

:handshake: Contributing :handshake:

Contributions to make DiaryApp better are always welcome!

If you are interested in seeing a particular feature implemented in this app, please open a new issue after which you can make a PR!

:scroll: License :scroll:

MIT License

Copyright (c) [2023] [Tonnie]

Permission is hereby granted, free of charge, to any person obtaining a copy of this softwa