/MyNotes

A Notes App

Primary LanguageKotlin

MyNotes

MyNotes Icon

Welcome to MyNotes, a simple and efficient note-taking application. With MyNotes, you can easily write and manage your notes with a clean and intuitive user interface. This app is built using modern Android development tools and follows the MVVM architecture pattern for maintainable and testable code.

Features

  • Write, edit, and delete notes
  • Clean and intuitive user interface
  • Persistent storage with Room Database
  • Dependency injection with Hilt
  • Built using Kotlin and Jetpack Compose
  • Follows MVVM architecture for a clean and maintainable codebase

Screenshots

MyNotes Screenshot MyNotes Screenshot

Technologies Used

  • Kotlin: The programming language used for the app
  • Jetpack Compose: Modern toolkit for building native Android UI
  • Room Database: Provides an abstraction layer over SQLite to allow fluent database access
  • Hilt: Dependency injection library for Android that reduces the boilerplate of doing manual dependency injection
  • MVVM Architecture: Model-View-ViewModel architecture for a clean separation of concerns

Installation

To get a local copy up and running follow these simple steps:

  1. Clone the repository:
    git clone https://github.com/yourusername/MyNotes.git
  2. Open the project in Android Studio:
    • Select Open an existing Android Studio project
    • Navigate to the cloned repository and click OK
  3. Build the project:
    • Click on Build in the menu and select Make Project or press Ctrl+F9
  4. Run the app:
    • Click on the Run button or press Shift+F10

Usage

  • Adding a note: Write Tilte and note then Click on "Save" to store the note.
  • Editing a note: Click on an existing note to edit it. Make your changes and click "Save".
  • Deleting a note: Click on a note then delete icon will apear click on it to delete it.