Commit 46d36a4a authored by Nina Rybárová's avatar Nina Rybárová
Browse files

updated readme

parent 95d0c236
Loading
Loading
Loading
Loading
+15 −12
Original line number Diff line number Diff line
# adnotes
# AdNotes

A new Flutter project.
AdNotes is a simple **Flutter** note-taking application that stores data locally in a JSON file within the app's document directory.  
It follows a clean architecture with a **Repository layer** for data persistence and a **Service layer** for business logic and reactive state management.

## Getting Started
## Features

This project is a starting point for a Flutter application.
- ✏️ **Create notes** – add a title and description.
- 📝 **Edit notes** – update existing notes using the same form.
- 🗑 **Delete notes** – remove notes with a confirmation dialog.
- 📄 **Note preview** – displays a list of notes with title, a short preview of the description, and creation date.
- 🔄 **Reactive UI** – changes are immediately reflected in the note list through streams.

A few resources to get you started if this is your first Flutter project:

- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
## Architecture
- **`NotesRepository`** – responsible for reading and writing notes from/to a local JSON file.
- **`NotesManagingService`** – manages the state of notes in a `BehaviorSubject` and saves changes through the repository.
- **`GetIt`** – used for dependency injection to easily access services and repositories throughout the app.
- **`rxdart`** – used for reactive state management with `BehaviorSubject`, providing an always-up-to-date stream of notes.
- **UI layer** uses `StreamBuilder` to listen for changes in the notes stream and rebuild the interface automatically.