Skip to content

AbdoTalaat74/Noteful

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Noteful

Overview

The Noteful is a modern Android application designed to help users efficiently create, edit, and manage notes with ease. Leveraging the latest technologies and best practices, this app ensures a seamless and responsive user experience.


Features

  • Create, Edit, and Delete Notes: Intuitive features to manage notes effortlessly.
  • Search Notes: Quickly find notes with a powerful search functionality.
  • Categorize Notes: Organize your notes into categories for better management.
  • Offline Support: Access your notes anytime, even without an internet connection.

Tech Stack

🚠 Architectural Pattern

  • Clean Architecture:

    • Modular structure with clear separation of concerns.
    • Divided into layers: Presentation, Domain, and Data.
  • MVVM (Model-View-ViewModel):

    • Enables reactive UI updates.
    • Improves maintainability and testability.

💻 UI Framework

  • Jetpack Compose:
    • For building a responsive, declarative, and modern UI.

⚙️ Dependency Injection

  • Dagger Hilt:
    • Simplifies dependency management, ensuring modularity and testability.

🔄 Asynchronous Programming

  • Coroutines:
    • For efficient and seamless handling of background operations.

📦 Data Persistence

  • Room Database:
    • Provides a robust, SQLite-based solution for local data storage.
    • Ensures offline accessibility and seamless data management.

Installation

Prerequisites

  • Android Studio Arctic Fox or newer.
  • Minimum Android SDK level: 21.

Steps to Run the App

  1. Clone this repository:
    git clone https://github.com/AbdoTalaat74/Noteful
  2. Open the project in Android Studio.
  3. Sync the project to download dependencies.
  4. Run the app on an emulator or a physical device.

Folder Structure

├── data
│   ├── repository   # Data sources implementation
│   ├── local        # Room database and DAO classes
├── domain
│   ├── model        # Business models
│   ├── repository   # Repository interfaces
│   ├── usecase      # Application business logic
├── presentation
│   ├── ui           # Composables and screens
│   ├── viewmodel    # State and logic management
├── di               # Dependency injection modules
└── utils            # Helper classes and functions

Screenshots

description description

Screen Record

Screen_recording_20250124_232644.mp4

Acknowledgements

  • Google: For Jetpack Compose, Room Database, and Android architecture guidelines.

Contact

For any inquiries, please reach out to:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages