hussein-basil / notify

notes mobile application with functionality of adding, viewing, editing and deleting notes

Notify

The Notes App is a simple Android application developed as a task after completing an Android development workshop. It allows users to view, add, and remove notes, with data persistence using Hawk to store notes even after the application is exited from.

Features

• View a list of saved notes.
• Add new notes with a title and description.
• Remove notes from the list.
• Data is stored persistently using Hawk, ensuring notes are saved even after the app is closed.

Prerequisites

• Android Studio: You need Android Studio to build and run the app.
• Android Device or Emulator: You can run the app on a physical Android device or an emulator provided by Android Studio.

Installation

1. Clone or download the repository to your local machine.

   git clone https://github.com/your-username/notes-app.git

2. Open the project in Android Studio.

3. Build and run the app on an Android device or emulator.

Usage

• Launch the Notes App on your Android device or emulator.
• View existing notes on the main screen.
• To add a new note, click the "+" button and enter a title and description.
• To remove a note, click the delete icon next to the note.
• The app will persistently store your notes using Hawk.

Technologies Used

• Android Studio: The primary IDE for Android app development.
• Kotlin: The programming language used for Android app development.
• Hawk: A simple key-value storage for Android.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them to your branch.
4. Push your changes to your fork.
5. Create a pull request to merge your changes into the main project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Thanks to Mohamed Taqy for leading the Android development workshop.
• Special thanks to the contributors of the libraries used in this project.

---

Feel free to customize and expand upon this README.md to provide more details about your Notes App, its functionality, and how to use it. Additionally, include any specific installation or usage instructions that might be unique to your app.