https://github.com/aritra-tech/Notify

📝 Notify is a simple note application build to demonstrate the use of clean MVVM Architecture with Jetpack Compose and Material-3 guidelines along with some Modern Android development tools.
https://github.com/aritra-tech/Notify

android compose dependency-injection good-first-issue hacktoberfest hilt-android jetpack-compose kotlin material-design mvvm-android mvvm-architecture note-taking-app notes-app open-source room

Last synced: about 2 months ago
JSON representation

📝 Notify is a simple note application build to demonstrate the use of clean MVVM Architecture with Jetpack Compose and Material-3 guidelines along with some Modern Android development tools.

• Host: GitHub
• URL: https://github.com/aritra-tech/Notify
• Owner: aritra-tech
• License: mit
• Created: 2023-06-27T06:20:37.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-05-20T23:02:19.000Z (4 months ago)
• Last Synced: 2024-05-21T08:17:05.926Z (4 months ago)
• Topics: android, compose, dependency-injection, good-first-issue, hacktoberfest, hilt-android, jetpack-compose, kotlin, material-design, mvvm-android, mvvm-architecture, note-taking-app, notes-app, open-source, room
• Language: Kotlin
• Homepage:
• Size: 6.09 MB
• Stars: 269
• Watchers: 4
• Forks: 63
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        






Notify




  

  

   

  

  

  

  

    

  

  

  

    

  

  

  

  

  



📝Notify is a simple note application that is built with Modern Android development tools.    

This project showcases the Good implementation of Android with proper architecture design.              

Made with ♥ for all Android Developers







I’m building it in public. So the idea is for everyone to contribute, leave comments, suggest ideas, etc. using the Discussions tab.







Please go through the CONTRIBUTING.md file before you start contributing.











  

# ⬇️ Download











# Features ✨

_Notify_ focuses on the following key things:

- Single Activity Design.

- Offline Capability - Notes. ✈️

- Clean and Simple Material UI. 🎨

- Dark mode. 🌗

- Back/Restore feature. 👀

- Jetpack Compose UI. 🖌

- Switch between layouts. 🌟

- Share the notes in the form of Text, Image & PDF 📤

# Built with 🛠

- [Kotlin](https://kotlinlang.org/) - First class and official programming language for Android development.

- [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) - For asynchronous calls and tasks to utilize threads.

- [Jetpack Compose UI Toolkit](https://developer.android.com/jetpack/compose) - Modern UI development toolkit.

- [Android Architecture Components](https://developer.android.com/topic/libraries/architecture) - Collection of libraries that help you design robust, testable, and maintainable apps.

  - [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) - Data objects that notify views when the underlying database changes.

  - [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - Stores UI-related data that isn't destroyed on UI changes.

  - [Room](https://developer.android.com/topic/libraries/architecture/room) - Room is an Android library which is an ORM that wraps Android's native SQLite database.

  - [StateFlow and SharedFlow](https://developer.android.com/kotlin/flow/stateflow-and-sharedflow#:~:text=StateFlow%20is%20a%20state%2Dholder,property%20of%20the%20MutableStateFlow%20class.) - StateFlow and SharedFlow are Flow APIs that enable flows to optimally emit state updates and emit values to multiple consumers.

- [Dependency Injection](https://developer.android.com/training/dependency-injection) -

    - [Hilt-Dagger](https://dagger.dev/hilt/) - A standard way to incorporate Dagger dependency injection into an Android application.

    - [Hilt-ViewModel](https://developer.android.com/training/dependency-injection/hilt-jetpack) - DI for injecting ```ViewModel```. 

- [Material Components for Android](https://github.com/material-components/material-components-android) - Modular and customizable Material Design UI components for Android.

- [Accompanist](https://google.github.io/accompanist/) - A collection of extension libraries for Jetpack Compose.

- [Biometric](https://developer.android.com/jetpack/androidx/releases/biometric) - Authenticate with biometrics or device credentials, and perform cryptographic operations.

- [gson](https://github.com/google/gson) - A Java serialization/deserialization library to convert Java Objects into JSON and back

- [Coil](https://github.com/coil-kt/coil) - Image loading for Android backed by Kotlin Coroutines.

- [Telephoto](https://github.com/saket/telephoto) - Building blocks for designing media experiences in Compose UI

- [Camera X](https://developer.android.com/jetpack/androidx/releases/camera) - CameraX is an addition to Jetpack that makes it easier to add camera capabilities to your app

# Architecture 👷‍♂️

This app uses [MVVM(Model View View-Model)](https://developer.android.com/topic/architecture#recommended-app-arch) architecture.

![MVVM](art/mvvm.png)



  

# Contributors 📢




  



# Star History ⭐

[![Star History Chart](https://api.star-history.com/svg?repos=aritra-tech/Notify&type=Date)](https://star-history.com/#aritra-tech/Notify&Date)

# Find this repository useful? ❤️

Support it by joining __[stargazers](https://github.com/aritra-tech/Notify/stargazers)__ for this

repository. :star: 


And __[follow](https://github.com/aritra-tech)__ me for my next creations! 🤩