Lamun365 / Notepad

Notepad

MVVM andrioid note taking app

Notepad is a open source note taking app that follows MVVM architectural design pattern

You can Install and test latest Notepad app from below 👇

⚙️ Features

• Create simple notes or checklist (todo) list
• Sort notes by date crated and title
• Dark Theme
• Quick search to find all notes
• Gird View
• Auto-saved

🚀 Technology Used

• Notepad built using Kotlin
• Room Database

📸 Screenshots

Built With 🛠

• Kotlin - First class and official programming language for Android development.
• Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
  • LiveData - Data objects that notify views when the underlying database changes.
  • ViewModel - Stores UI-related data that isn't destroyed on UI changes.
  • ViewBinding - Generates a binding class for each XML layout file present in that module and allows you to more easily write code that interacts with views.
  • Room - Room is a database layer on top of a SQLite database. Room takes care of mundane tasks that you used to handle with a SQLiteOpenHelper.
• Dependency Injection -
  • Hilt-Dagger - Standard library to incorporate Dagger dependency injection into an Android application.
  • Hilt-ViewModel - DI for injecting ViewModel.
• DataStore - Jetpack DataStore is a data storage solution that allows you to store key-value pairs or typed objects with protocol buffers. DataStore uses Kotlin coroutines and Flow to store data asynchronously, consistently, and transactionally.
• Material Components for Android - Modular and customizable Material Design UI components for Android.

Package Structure

com.lexo.notepad        # Root Package
.
├── db                # For data handling.
|
├── di                  # Dependency Injection             
|
├── ui                  # Activity/View layer
│   ├── viewmodel       # ViewModels
│   └── adapter         # Adpaters
│   └── fragment        # Fragnents
|
└── util               # Utility Classes / Kotlin extensions

Architecture

This app uses MVVM (Model View View-Model) architecture.

License

MIT License

Copyright (c) 2021 Lamun

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.