/NeverNote

📝 A Simple Note and Task App built to demonstrate the use of Modern Android development tools - (Kotlin, Coroutines, Flow, Architecture Components, MVVM, Room, Material Design Components, Notifications and more).

Primary LanguageKotlinMIT LicenseMIT

NeverNote

📝 A Simple Note and Task App built to demonstrate the use of Modern Android development tools - (Kotlin, Coroutines, Flow, Architecture Components, MVVM, Room, Material Design Components, Notifications and more). Made with love ❤️ by llastkrakw

GitHub Cards Preview

Try latest NeverNote app from below 👇

NeverNote on playstore

MAD Skills

MAD Skills Card

Getting Started

Unsplash API key

NeverNote uses the Unsplash API to load pictures on note background. To use the API, you will need to obtain a free developer API key. See the Unsplash API Documentation for instructions.

Once you have the key, update these lines to the build.gradle file, usually ~/app/build.gradle in the project's root folder:

        buildConfigField "String", "UNSPLASH_ACCESS_KEY", "\"my_unsplah_acces_key\""
        buildConfigField "String", "UNSPLASH_SECRET_KEY", "\"my_unsplah_secret_key\""

Some Screens

Light ☀️

Home Folder Detail Note Detail Task Editor

Dark 🌑

Home Search Note Search Task Note With Bg Reminder

Built With 🛠

  • Kotlin - First class and official programming language for Android development.
  • Coroutines - For asynchronous and more..
  • Broadcast Receiver - To build background alarm trigger
  • Notification Manager and Notification Channel - To make good pratice notification
  • 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.
    • Data Binding - Declaratively bind observable data to UI elements.
    • 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.
  • Audio Recording - Record and play audio with android framework.

Package Structure 📦


   📦nevernote
 ┣ 📂core
 ┃ ┣ 📂constants
 ┃ ┣ 📂converters
 ┃ ┗ 📂utilities
 ┣ 📂feature
 ┃ ┣ 📂note
 ┃ ┃ ┣ 📂adapters
 ┃ ┃ ┣ 📂datas
 ┃ ┃ ┃ ┣ 📂dao
 ┃ ┃ ┃ ┣ 📂database
 ┃ ┃ ┃ ┗ 📂entities
 ┃ ┃ ┣ 📂notification
 ┃ ┃ ┣ 📂receiver
 ┃ ┃ ┣ 📂repositories
 ┃ ┃ ┗ 📂viewModels
 ┃ ┗ 📂task
 ┃ ┃ ┣ 📂adapters
 ┃ ┃ ┣ 📂datas
 ┃ ┃ ┃ ┣ 📂dao
 ┃ ┃ ┃ ┣ 📂database
 ┃ ┃ ┃ ┗ 📂entities
 ┃ ┃ ┣ 📂notification
 ┃ ┃ ┣ 📂receiver
 ┃ ┃ ┣ 📂repositories
 ┃ ┃ ┗ 📂viewModels
 ┣ 📂views
 ┃ ┣ 📂notes
 ┃ ┃ ┣ 📂activities
 ┃ ┃ ┗ 📂fragments
 ┃ ┣ 📂splashScreen
 ┃ ┗ 📂task
 ┃ ┃ ┣ 📂activities
 ┃ ┃ ┗ 📂fragments
    

Architecture 🗼

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

Also Memento and Command pattern are use to make text editor.

Contribute 👏

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

Contact

Have an project? DM me at 👇

Drop a mail to:- llastkrakw21@gmail.com

License 🔖

MIT License

Copyright (c) 2021 llastkrakw

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.