https://github.com/anitaa1990/notesapp
A simple notes app to demo Room, Flow, Compose + MVI architecture in Android
https://github.com/anitaa1990/notesapp
android android-app android-application android-architecture compose-android kotlin-android kotlin-coroutines kotlin-flow mvi-android mvi-architecture rich-text-editor room-persistence-library
Last synced: 3 months ago
JSON representation
A simple notes app to demo Room, Flow, Compose + MVI architecture in Android
- Host: GitHub
- URL: https://github.com/anitaa1990/notesapp
- Owner: anitaa1990
- License: apache-2.0
- Created: 2024-08-28T10:31:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-30T18:47:33.000Z (about 1 year ago)
- Last Synced: 2025-02-11T13:55:25.510Z (11 months ago)
- Topics: android, android-app, android-application, android-architecture, compose-android, kotlin-android, kotlin-coroutines, kotlin-flow, mvi-android, mvi-architecture, rich-text-editor, room-persistence-library
- Language: Kotlin
- Homepage:
- Size: 2.23 MB
- Stars: 21
- Watchers: 1
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NotesApp
This is a demo android app on how to implement Room persistance library, making use of Kotlin Flows and Jetpack Compose.
### App features
* Users can add a new note to the local db.
* Users can view their list of notes from the local db.
* Users can update a note to the local db.
* Users can delete a note from the local db.
* Users can lock a note so that it requires a password to view.
* Dynamic theme included.
* Rich text editor is added – so users can style their note (basic styles includes: Bold, Italics, Underline, Strikethrough, Highlight, Heading, Subheading).
### App Architecture
Based on MVI (model-view-intent) architecture.
#### The app includes the following main components:
* A local database that servers as a single source of truth for data presented to the user.
* A repository that works with the database, providing a unified data interface.
* An intent class that handles incoming user actions/interactions with the app.
* A ViewModel that provides data specific for the UI.
* The UI, using Jetpack Compose, which shows a visual representation of the data in the ViewModel.
* Unit Test cases for API service, Database, Repository and ViewModel.
### App Packages
* model
* di - contains dependency injection classes, using Hilt.
* db - contains the db classes to cache network data.
* repository - contains the repository classes, which acts as a bridge between the data and other classes.
* view
* ui - contains compose components and classes needed to display note list and note detail screen.
* intent - contains classes that handles incoming user actions/interactions with the app.
* composetexteditor - contains classes required for a text editor to style note description.
* util - contains extension classes needed for date/time conversions.
#### App Specs
* Minimum SDK 26
* Written in [Kotlin](https://kotlinlang.org/)
* MVI Architecture
* Android Architecture Components (ViewModel, Room Persistence Library, Navigation Component for Compose)
* [Kotlin Coroutines]([url](https://kotlinlang.org/docs/coroutines-overview.html)) and [Kotlin Flows]([url](https://developer.android.com/kotlin/flow)).
* [Hilt]([url](https://developer.android.com/training/dependency-injection/hilt-android)) for dependency injection.
* [Gson](https://github.com/google/gson) for serialisation.
* [Mockito](https://site.mockito.org/) for implementing unit test cases