Skip to content
/ Notzz-App Public template

πŸ“ A Simple Note-Taking App built to demonstrate the use of Modern Android development tools - (Kotlin, Coroutines, State Flow, Hilt-Dependency Injection, Jetpack DataStore, Architecture Components, MVVM, Room, Material Design Components).

License

Notifications You must be signed in to change notification settings

TheCodeMonks/Notzz-App

Repository files navigation

GitHub Cards Preview

Notzz App

Notzz App is a simple note-taking πŸ“ Android application built to describe the use of Modern Android development tools. Made with love ❀️ by Spikeysanju

Try latest Notzz app apk from below πŸ‘‡

Notzz-App

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

thecodemonks.org.nottzapp   # Root Package
.
β”œβ”€β”€ data                # For data handling.
β”‚   β”œβ”€β”€ db              # Local Persistence Database. Room (SQLite) database
|   β”‚   β”œβ”€β”€ dao         # Data Access Object for Room   
|   |   |── database    # Database Instance
|
β”œβ”€β”€ model               # Model classes
|
|
β”œβ”€β”€ ui                  # Activity/View layer
β”‚   β”œβ”€β”€ main            # Main Screen Activity & ViewModel
|   β”‚   β”œβ”€β”€ adapter     # Adapter for RecyclerView
|   β”‚   └── viewmodel   # ViewHolder for RecyclerView   


## Architecture

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

Contribute

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

Contact

Have an project? DM us at πŸ‘‡

Drop a mail to:- thecodemonksorg@gmail.com

Donation

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

paypal

License

MIT License

Copyright (c) 2020 Spikey Sanju

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.