Notes 📙

A Simple Note Taking App 📱 built to demonstrate the use of modern android architecture component with MVVM Architecture 🏗. Made with love ❤️ by Sammie_kt

Try latest Notes app apk from below 👇

Day Mode 🌞

Splash	Home	Notes	Courses	Bookmarks	Result	Profile

We Support Dark Mode Too 🌚

Splash	Home	Notes	Courses	Bookmarks	Result	Profile

Built With 🛠

• Kotlin - First class and official programming language for Android development.
• Coroutines - For asynchronous and more..
• Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
  • Stateflow - StateFlow is a state-holder observable flow that emits the current and new state updates to its collectors.
  • Flow - A flow is an asynchronous version of a Sequence, a type of collection whose values are lazily produced.
  • ViewModel - Stores UI-related data that isn't destroyed on UI changes.
  • Room - SQLite object mapping library.
  • Jetpack Navigation - Navigation refers to the interactions that allow users to navigate across, into, and back out from the different pieces of content within your app
  • 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 📦

dev.spikeysanju.expenso # Root Package
├── di                  # Hilt DI Modules 
├── data                # For data handling.
│   ├── local           # Local Persistence Database. Room (SQLite) database
|   │   ├── dao         # Data Access Object for Room   
|   |   |── database    # Database Instance
|
├── model               # Model classes [Transaction]
|
|-- repo                # Used to handle all data operations
|
├── view                # Activity/Fragment View layer
│   ├── main            # Main root folder
|   │   ├── main        # Main Activity for RecyclerView
|   │   └── viewmodel   # Transaction ViewModel
|   │   ├── adapter     # Adapter for RecyclerView
│   ├── Dashboard       # Dashboard root folder
|   |   |__ dashboard   # Dashboard 
│   ├── Add             # Add Transaction root folder
|   |   |__ add         # Add Transaction 
│   ├── Edit            # Edit Transaction root folder
|   |   |__ edit        # Edit Transaction
│   ├── Details         # Add Transaction root folder
|   |   |__ details     # Transaction Details
│   ├── About           # About root folder
|   |   |__ about       # About 
│   ├── Dialog          # All Dialogs root folder
|   |   |__ dialog      # Error Dialog 
├── utils               # All extension functions

Architecture 🗼

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

Build-tool 🧰

You need to have Android Studio to build this project.

Contribute 🤝

If you want to contribute to this app, you're always welcome! See Contributing Guidelines.

Contact 📩

Have a project? DM us at 👇

Drop a mail to:- achiagasamson5@gmail.com

Donation 💰

If this project help you reduce time to develop, you can give me a cup of coffee :)

License 🔖

    Apache 2.0 License


    Copyright 2021 Samson Achiaga

    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.