Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.17 KB

README.md

File metadata and controls

34 lines (27 loc) · 1.17 KB

NotesApp

This project aims to learn the new Android components by Google such as Jetpack compose, ViewModels, Kotlin Coroutines, Asynchronous Flow.

The scope for the UI will be reduced wherever possible to save time and the focus area will be clean architecture following Modern App Architecture.

How to run

  1. Create a firebase project and register an android app inside it.
  2. Download google-services.json file and copy over under the app/ folder
  3. Create a firestore database instance in Test mode (not recommended for production) and make sure security rules allow read / writes to /notes collection

Functionality

  • Show a list of notes fetched from the database
  • Show note details
  • Edit existing note
  • Delete note
  • Search
  • Add note as favourite
  • Sort notes by created date, title
  • Empty state and loading state
  • Offline availability

Refactors & Notes

  • Refactor all harcoded strings
  • Use dependency injection with Hilt
  • Start adding some tests
List Details Add New