{"id":15110580,"url":"https://github.com/anitaa1990/notesapp","last_synced_at":"2025-10-18T21:10:20.059Z","repository":{"id":255525818,"uuid":"848746013","full_name":"anitaa1990/NotesApp","owner":"anitaa1990","description":"A simple notes app to demo Room, Flow, Compose + MVI architecture in Android","archived":false,"fork":false,"pushed_at":"2024-11-30T18:47:33.000Z","size":2335,"stargazers_count":21,"open_issues_count":1,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-11T13:55:25.510Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anitaa1990.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-28T10:31:31.000Z","updated_at":"2025-01-16T13:36:28.000Z","dependencies_parsed_at":"2024-09-05T23:28:02.334Z","dependency_job_id":"01190a8b-0c16-45f4-a061-0fdf7e3626d8","html_url":"https://github.com/anitaa1990/NotesApp","commit_stats":null,"previous_names":["anitaa1990/notesapp"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anitaa1990%2FNotesApp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anitaa1990%2FNotesApp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anitaa1990%2FNotesApp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anitaa1990%2FNotesApp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anitaa1990","download_url":"https://codeload.github.com/anitaa1990/NotesApp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238306527,"owners_count":19450145,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["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"],"created_at":"2024-09-26T00:00:37.776Z","updated_at":"2025-10-18T21:10:19.978Z","avatar_url":"https://github.com/anitaa1990.png","language":"Kotlin","readme":"# NotesApp\nThis is a demo android app on how to implement Room persistance library, making use of Kotlin Flows and Jetpack Compose.\u003c/br\u003e\u003c/br\u003e \n\u003cimg src=\"https://github.com/anitaa1990/NotesApp/blob/main/media/1.png\" width=\"200\" style=\"max-width:100%;\"\u003e  \u003cimg src=\"https://github.com/anitaa1990/NotesApp/blob/main/media/2.png\" width=\"200\" style=\"max-width:100%;\"\u003e   \u003cimg src=\"https://github.com/anitaa1990/NotesApp/blob/main/media/3.png\" width=\"200\" style=\"max-width:100%;\"\u003e   \n\u003cimg src=\"https://github.com/anitaa1990/NotesApp/blob/main/media/4.png\" width=\"200\" style=\"max-width:100%;\"\u003e   \u003cimg src=\"https://github.com/anitaa1990/NotesApp/blob/main/media/5.png\" width=\"200\" style=\"max-width:100%;\"\u003e   \u003cimg src=\"https://github.com/anitaa1990/NotesApp/blob/main/media/6.png\" width=\"200\" style=\"max-width:100%;\"\u003e   \n\u003cimg src=\"https://github.com/anitaa1990/NotesApp/blob/main/media/7.png\" width=\"200\" style=\"max-width:100%;\"\u003e   \u003cimg src=\"https://github.com/anitaa1990/NotesApp/blob/main/media/8.png\" width=\"200\" style=\"max-width:100%;\"\u003e   \u003cimg src=\"https://github.com/anitaa1990/NotesApp/blob/main/media/9.png\" width=\"200\" style=\"max-width:100%;\"\u003e\n\n\n### App features\n* Users can add a new note to the local db.\n* Users can view their list of notes from the local db.\n* Users can update a note to the local db.\n* Users can delete a note from the local db.\n* Users can lock a note so that it requires a password to view.\n* Dynamic theme included.\n* Rich text editor is added – so users can style their note (basic styles includes: Bold, Italics, Underline, Strikethrough, Highlight, Heading, Subheading).\n\n### App Architecture\nBased on MVI (model-view-intent) architecture.\n\n\u003cimg src=\"https://github.com/anitaa1990/NotesApp/blob/main/media/10.png\" width=\"300\" style=\"max-width:300%;\"\u003e\n\n#### The app includes the following main components:\n\n* A local database that servers as a single source of truth for data presented to the user. \n* A repository that works with the database, providing a unified data interface.\n* An intent class that handles incoming user actions/interactions with the app.\n* A ViewModel that provides data specific for the UI.\n* The UI, using Jetpack Compose, which shows a visual representation of the data in the ViewModel.\n* Unit Test cases for API service, Database, Repository and ViewModel.\n\n### App Packages\n* \u003cb\u003emodel\u003c/b\u003e \n    * \u003cb\u003edi\u003c/b\u003e - contains dependency injection classes, using Hilt.\n    * \u003cb\u003edb\u003c/b\u003e - contains the db classes to cache network data.\n    * \u003cb\u003erepository\u003c/b\u003e - contains the repository classes, which acts as a bridge between the data and other classes.\n * \u003cb\u003eview\u003c/b\u003e \n    * \u003cb\u003eui\u003c/b\u003e - contains compose components and classes needed to display note list and note detail screen.\n* \u003cb\u003eintent\u003c/b\u003e - contains classes that handles incoming user actions/interactions with the app.\n* \u003cb\u003ecomposetexteditor\u003c/b\u003e - contains classes required for a text editor to style note description.\n* \u003cb\u003eutil\u003c/b\u003e - contains extension classes needed for date/time conversions.\n\n#### App Specs\n* Minimum SDK 26\n* Written in [Kotlin](https://kotlinlang.org/)\n* MVI Architecture\n* Android Architecture Components (ViewModel, Room Persistence Library, Navigation Component for Compose)\n* [Kotlin Coroutines]([url](https://kotlinlang.org/docs/coroutines-overview.html)) and [Kotlin Flows]([url](https://developer.android.com/kotlin/flow)).\n* [Hilt]([url](https://developer.android.com/training/dependency-injection/hilt-android)) for dependency injection.\n* [Gson](https://github.com/google/gson) for serialisation.\n* [Mockito](https://site.mockito.org/) for implementing unit test cases\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanitaa1990%2Fnotesapp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanitaa1990%2Fnotesapp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanitaa1990%2Fnotesapp/lists"}