{"id":20940255,"url":"https://github.com/mohamedmagdy2301/notes_app","last_synced_at":"2025-04-22T17:25:47.105Z","repository":{"id":251566646,"uuid":"837788585","full_name":"mohamedmagdy2301/notes_app","owner":"mohamedmagdy2301","description":"Notes app is a simple Notes Application built with Flutter and Hive, demonstrating the use of BLoC for state management. The app allows users to add, edit, delete, and view notes efficiently.","archived":false,"fork":false,"pushed_at":"2024-11-20T15:52:35.000Z","size":2847,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T17:11:55.772Z","etag":null,"topics":["add","cubit","dark","dark-mode","dark-theme","dart","delet","edit","flutter","flutter-apps","hive","localstorage","notes","notes-app","splash-screen","splashscreen"],"latest_commit_sha":null,"homepage":"https://appetize.io/app/b_fzxjekczrapwxdywv3t7mouno4","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mohamedmagdy2301.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-04T03:22:22.000Z","updated_at":"2025-02-13T15:22:00.000Z","dependencies_parsed_at":"2024-08-14T00:34:21.427Z","dependency_job_id":"65284565-c292-4432-9990-b89cb0a79737","html_url":"https://github.com/mohamedmagdy2301/notes_app","commit_stats":null,"previous_names":["mohamedmagdy2301/notes_app"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohamedmagdy2301%2Fnotes_app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohamedmagdy2301%2Fnotes_app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohamedmagdy2301%2Fnotes_app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohamedmagdy2301%2Fnotes_app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mohamedmagdy2301","download_url":"https://codeload.github.com/mohamedmagdy2301/notes_app/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250286212,"owners_count":21405386,"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":["add","cubit","dark","dark-mode","dark-theme","dart","delet","edit","flutter","flutter-apps","hive","localstorage","notes","notes-app","splash-screen","splashscreen"],"created_at":"2024-11-18T23:09:42.635Z","updated_at":"2025-04-22T17:25:47.082Z","avatar_url":"https://github.com/mohamedmagdy2301.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# *\"وَقُلْ رَبِّ زِدْنِي عِلْمًا\"*\n\n\u003c/div\u003e\n\u003cbr clear=\"both\"\u003e\n\u003ca href=\"https://git.io/typing-svg\"\u003e\u003cimg src=\"https://readme-typing-svg.demolab.com?font=Protest+Guerrilla\u0026weight=900\u0026size=45\u0026pause=1000\u0026color=F78918\u0026width=835\u0026height=100\u0026lines=Notes+App+%F0%9F%98%8A%E2%9C%8C%EF%B8%8F\" alt=\"Typing SVG\" /\u003e\u003c/a\u003e\n\u003cbr clear=\"both\"\u003e\n\n\nThis project is a simple **Notes Application** built with **Flutter** and **Hive**, demonstrating the use of **BLoC** for state management. The app allows users to **add**, **edit**, **delete**, and **view notes** efficiently.\n\n[![Flutter Version](https://img.shields.io/badge/Flutter-v3.0-blue.svg)](https://flutter.dev/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n---\n\n\n## Features\n\n1. **Add Notes**  \n   - Add notes with a title, content, and optional color.\n   - Input validation is implemented for both the title and content fields.\n\n2. **View Notes**  \n   - Displays a list of all saved notes.\n   - If no notes are available, an empty state with a message is shown.\n\n3. **Edit Notes**  \n   - Modify the details of existing notes directly from the list.\n\n4. **Delete Notes**  \n   - Remove a single note or clear all notes.\n   - Confirmation dialogs ensure accidental deletions are avoided.\n\n5. **Persistent Storage**  \n   - Uses **Hive** for offline storage, ensuring all notes are saved and retrieved seamlessly.\n\n---\n\n## Project Structure\n\n### Main Components\n\n- **Main Entry (`main.dart`)**: \n  - Initializes Hive, registers adapters, and sets up the BLoC observer.\n  - Entry point of the app with a MaterialApp wrapped in a `BlocProvider`.\n\n- **View Notes (`NotesView`)**:\n  - Displays the list of notes using a `BlocBuilder`.\n  - Provides options for adding or clearing notes via the app bar and FAB.\n\n- **Add Notes (`AddNoteBottomSheet` \u0026 `AddNoteForm`)**:\n  - A bottom sheet for adding a new note.\n  - Includes input validation and form submission.\n\n- **UI Widgets**:\n  - `CustomerAppBar`: Customizable app bar.\n  - `CustomerListBody`: Displays the list of notes.\n  - `CustomerNoListBody`: UI for the empty state when no notes are available.\n  - `CustomerNoteItem`: Renders individual note items.\n\n---\n\n## Screenshots\n\n| Splash Screen | Empty Notes Screen | View Notes Screen | Edit Screen |\n|---|---|---|---|\n| ![Screenshot](assets/screenshots/splash.png) | ![Screenshot](assets/screenshots/emptyNotse.png) | ![Screenshot](assets/screenshots/view_notes.png)  | ![Screenshot](assets/screenshots/edit_notes.png)  |\n\n| Bottom Sheet Screen | Add Notes Screen | Added Notes Screen | Dialog Edit Screen | Dialog Edit Screen |\n|---|---|---|---|---|\n| ![Screenshot](assets/screenshots/bottom_sheet.png) | ![Screenshot](assets/screenshots/bottom_sheet_add_notes.png) | ![Screenshot](assets/screenshots/add_notes.png)  |  ![Screenshot](assets/screenshots/dialog_edit.png) |  ![Screenshot](assets/screenshots/dialog_delete.png)|\n\n---\n\n## Setup Instructions\n\n### Prerequisites\n\n- Flutter SDK installed.\n- `Hive` and `BLoC` packages included in `pubspec.yaml`.\n- Development environment (VSCode, Android Studio, etc.).\n\n### Steps to Run\n\n1. **Clone the repository**:  \n   ```bash\n   git clone \u003crepository-url\u003e\n   cd notes-app\n   ```\n\n2. **Install dependencies**:  \n   ```bash\n   flutter pub get\n   ```\n\n3. **Run the app**:  \n   ```bash\n   flutter run\n   ```\n\n---\n\n## Packages Used\n\n- **[Flutter BLoC](https://pub.dev/packages/flutter_bloc)**: State management solution.\n- **[Hive](https://pub.dev/packages/hive)**: Lightweight and fast database for Flutter.\n- **[intl](https://pub.dev/packages/intl)**: Formatting dates.\n\n---\n\n## Folder Structure\n\n```\nlib/\n├── cubits/\n│   ├── add_note_cubit/\n│   │   ├── add_note_cubit.dart\n│   │   └── add_note_state.dart\n│   └── view_note_cubit/\n│       ├── view_note_cubit.dart\n│       └── view_note_state.dart\n├── helper/\n│   └── constant.dart\n├── models/\n│   └── note_model.dart\n├── views/\n│   ├── notes_view.dart\n│   └── widgets/\n│       ├── add_note_bottom_sheet.dart\n│       ├── add_note_form.dart\n│       ├── customer_appbar.dart\n│       ├── customer_list_body.dart\n│       ├── customer_no_list_body.dart\n│       └── customer_note_item.dart\n└── main.dart\n```\n\n---\n\n## How to Use\n\n1. **Adding Notes**:  \n   - Tap the floating action button to open the bottom sheet.\n   - Fill in the title and content fields.\n   - Tap the \"Save\" button to add the note.\n\n2. **Viewing Notes**:  \n   - All notes appear on the main screen.\n   - If no notes exist, a placeholder message will be shown.\n\n3. **Deleting Notes**:  \n   - Tap the trash icon on the app bar to clear all notes.\n\n---\n\n## Contributing\n\nContributions are welcome! Feel free to submit a Pull Request with improvements, bug fixes, or new features.\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature/my-feature`).\n3. Make your changes and commit (`git commit -am 'Add new feature'`).\n4. Push to the branch (`git push origin feature/my-feature`).\n5. Create a new Pull Request.\n\n## Congratulations\n\nYou’ve successfully integrated Notes App into your Flutter app! For more advanced features and customization options.\n\nIf you found this guide helpful, don’t forget to ⭐ star this repository on GitHub to show your support!\n\nThank you for reading!\n\n## Contact\n\nFor any questions or inquiries, feel free to reach out:\n\n- **GitHub:** [mohamedmagdy2301](https://github.com/mohamedmagdy2301)\n- **Email:** [mohammedmego15@gmail.com](mohammedmego15@gmail.com)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohamedmagdy2301%2Fnotes_app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmohamedmagdy2301%2Fnotes_app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohamedmagdy2301%2Fnotes_app/lists"}