Skip to content

Latest commit

 

History

History
61 lines (50 loc) · 3.05 KB

README.md

File metadata and controls

61 lines (50 loc) · 3.05 KB

NoteU

Description

NoteU is a note-taking application that empowers users to effortlessly create, read, update, and delete notes. With NoteU, users can conveniently add info to their notes, edit existing notes and delete specific notes. The app follows the MVVM architecture pattern and utilizes Room database to store and manage user's notes effectively.

Table of Contents

Features

  • Create notes: Add a title and description to create new notes.
  • Read notes: View the titles and descriptions of all notes for easy reference.
  • Edit notes: Modify the title and description of existing notes to keep them up to date.
  • Delete notes: Remove specific notes that are no longer needed or you can delete all notes just using one button

Supported platforms

Android

Installation

To run this app locally, follow these steps:

  1. Clone this repository to your local machine.
  2. Open Android Studio and select "Open an existing project."
  3. Navigate to the project directory and select the project's root folder.
  4. Connect a device or start an emulator.
  5. Build and run the app by clicking on the "Run" button in Android Studio or by running the command ./gradlew installDebug in the project's root directory.

Usage

  1. Open NoteU on your device or emulator.
  2. Press the "Add" icon on the app bar to create your first note.
  3. Enter a title and description for the note, then press the "Save" button.
  4. To edit the content of a note, simply tap on the specific note you wish to modify.
  5. Update the title and description with the desired changes, then press the "Save" button.
  6. If you want to delete a note, swipe it either left or right.
  7. Confirm the deletion by selecting "Yes" on the confirmation dialog.
  8. To delete all notes at once, tap on the "Delete" option on the app bar, then confirm by selecting "Yes" on the confirmation dialog.

Screenshots and Demo

Screenshots

Screenshot_1 Screenshot_2 Screenshot_3 Screenshot_4

Demo

Demo.webm

License

Apache License Version 2.0