Architecture Mining

Here’s a focused review of **ZettelkastenFX** and a concrete plan to align it with a clean, decoupled JavaFX architecture. # Snapshot of the repo * The repo’s purpose is explicitly an **exploration of migrating Zettelkasten from Swing to JavaFX** (README). ([GitHub][1]) * It’s a **Maven** project (pom.xml present). ([GitHub][2]) * The tree includes a `src` directory plus analysis artifacts like `ZettelkastenFX.mse` (likely from architecture mining), indicating you’ve been exploring structure before coding. ([GitHub][1]) * Two open issues frame the intent: **“Migrating From Swing to JavaFX?”** and **“Use JavaFX+Sodium FRP library?”**—pointing to UI tech choices and reactive state. ([GitHub][3]) * Context: the classic **Zettelkasten-Team/Zettelkasten** targets **Java 8 + Maven**, i.e., Swing-era constraints and tight UI coupling—precisely what you want to leave behind. ([GitHub][4]) # What’s good * Clear goal (JavaFX exploration) and a lightweight repo to iterate quickly. ([GitHub][1]) * Early consideration of **FRP** (Sodium) suggests you’re thinking about **event-driven state**, which fits perfectly with a decoupled model and JavaFX bindings. ([GitHub][5]) # Gaps / risks I see * No visible “core domain” split yet. To truly decouple, **model + services + events** must live outside any UI toolkit. * JavaFX choices (FXML vs programmatic, RichTextFX, ControlsFX, etc.) and **MVVM** shape aren’t recorded as decisions yet (issues are open-ended). ([GitHub][3]) * Migration strategy from the Swing app (Java 8) to a modern JDK is not codified; the old repo still mandates JDK8. ([GitHub][4]) # Recommended target architecture (fits both Swing and JavaFX) Re-use the **UI-agnostic core** we drafted (entities, repositories, services, EventBus). Then add JavaFX on top using **MVVM**: ``` zk-core/ // pure Java (model, ports, services, events) zk-storage/ // adapters to old Zettelkasten data (later) zk-ui-javafx/ // JavaFX views + viewmodels (MVVM) zk-ui-swing-bridge/ // optional: lets old Swing talk to zk-core during transition ``` * **MVVM in JavaFX** * **Model**: your `zk-core` DTOs & services. * **ViewModel**: exposes JavaFX `ObservableValue` / `ObservableList` for binding; subscribes to `EventBus`. * **View**: FXML or code; binds to ViewModel properties; *zero* domain logic. Why MVVM? JavaFX binding + properties make it natural: the ViewModel reacts to domain events (e.g., `SelectionChanged`, `NoteUpdated`) and the View just updates. # Library picks (battle-tested) * **RichTextFX** for the editor/preview pane (styled text/markdown rendering). * **ControlsFX** for extra controls (notifications, master/detail). * **Ikonli** for icons. * (Optional) **ReactFX** or **Sodium** if you want explicit FRP streams; otherwise, plain JavaFX bindings + your `EventBus` suffice. # First milestone (concrete) **Goal:** Recreate the main window’s essentials (from your screenshot) on top of the decoupled core: 1. **Core wiring** (already provided): `NoteService`, `SelectionModel`, `NoteFacade`, `EventBus`. 2. **JavaFX shell** (`zk-ui-javafx`): * `MainView.fxml`: `BorderPane` with * Center: `NotePane` (title, body) * Right: `SidebarTabs` with **Folgezettel**, **Schlagwörter**, **Links** * Top: toolbar (history back/forward, search field) * `MainViewModel`: * `selectedTitle: StringProperty` * `selectedBody: StringProperty` * `links: ObservableList<NoteId>` * `sequenceChildren: ObservableList<NoteId>` * `keywords: ObservableList<String>` * subscribes to `SelectionChanged`, pulls `NoteFacade.view(id)` * `MainController` binds FXML controls to the ViewModel. 3. **In-memory adapters** (already provided) so the JavaFX app runs without touching legacy storage. 4. **Minimal navigation**: * Back/forward buttons call `HistoryService`. * Selecting a note in a side list calls `SelectionModel.select(id)` and everything else updates via events. # Why this matches Zettelkasten The panes and commands mirror the official Swing UI (Notes, Outliner/Folgezettel, Keywords, Links, History, Search), but **all logic is in core** so JavaFX is just bindings & layout. ([GitHub][4]) # Concrete, immediate next steps for ZettelkastenFX 1. Turn the repo into a **multi-module Maven** build (aggregator POM with `zk-core` and `zk-ui-javafx`). 2. Drop in the **core** interfaces/services/events we drafted and commit them as `zk-core`. 3. Add `zk-ui-javafx` with: * `MainApp` (JavaFX `Application`), `MainView.fxml`, `MainViewModel`, `MainController`. * Wire to `Core` (in-memory repos) and render one note and its right-hand lists. 4. Add **RichTextFX** dependency for the body pane (view-only is fine initially). 5. Open issues to track parity with Swing panes (Keywords, Links, Literature, Bookmarks, Attachments) and move them one by one. # Suggested issue titles to add * “Adopt MVVM in zk-ui-javafx (ViewModels per pane)” * “Introduce RichTextFX for note body” * “History buttons bind to HistoryService + SelectionModel” * “Keywords pane: list + add/remove (bind to KeywordsChanged)” * “Folgezettel pane: list + reorder (bind to SequenceChanged)” * “Link insertion UI (bind to LinksChanged)” # Conventional commit to start the split ``` feat(core): add UI-agnostic domain model, ports, services, and event bus feat(ui-javafx): add JavaFX shell with MVVM scaffolding and bindings to core chore(build): convert to multi-module Maven (core, ui-javafx) ``` If you want, I can paste a compact `MainApp + MainView.fxml + MainViewModel` that binds to the `Core` we already drafted so you can run `mvn javafx:run` immediately. [1]: https://github.com/RalfBarkow/ZettelkastenFX "GitHub - RalfBarkow/ZettelkastenFX: Zettelkasten: To migrate to JavaFX, or not to migrate?" [2]: https://github.com/RalfBarkow/ZettelkastenFX/blob/main/pom.xml "ZettelkastenFX/pom.xml at main · RalfBarkow/ZettelkastenFX · GitHub" [3]: https://github.com/RalfBarkow/ZettelkastenFX/issues "GitHub · Where software is built" [4]: https://github.com/Zettelkasten-Team/Zettelkasten?utm_source=chatgpt.com "Zettelkasten-Developer-Builds" [5]: https://github.com/RalfBarkow/ZettelkastenFX/issues/2 "Use JavaFX+Sodium FRP library ? · Issue #2 · RalfBarkow/ZettelkastenFX · GitHub"