Skip to content

Updates from the development branch #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 37 commits into from
Apr 14, 2025
Merged

Updates from the development branch #5

merged 37 commits into from
Apr 14, 2025

Conversation

mumez
Copy link
Owner

@mumez mumez commented Apr 14, 2025

This pull request includes comprehensive updates to the documentation, specifically focusing on a step-by-step tutorial for using the framework to build a sample bank account application. The changes span multiple files and cover various aspects of the framework, from model and event definitions to advanced features like event replay and time traveling.

Key changes include:

Tutorial Introduction:

  • Added a new introduction section explaining the framework and outlining the key classes needed for a sample bank account application (doc/tutorial/01_introduction.md).

Model, Event, and ModelSpace Implementation:

  • Detailed steps for defining the model class HtBankAccount, including attributes and initialization (doc/tutorial/02_model_implementation.md).
  • Instructions for defining the event class HtBankAccountBalanceChanged and registering it (doc/tutorial/03_event_implementation.md).
  • Explanation of the ModelSpace class HtBankAccountSpace and its functionalities (doc/tutorial/04_modelspace_implementation.md).

Mutations and Domain Actions:

  • Step-by-step guide on implementing mutations for the balance attribute of the HtBankAccount model (doc/tutorial/05_mutations.md).
  • Added domain-specific actions to the HtBankAccountSpace for operations like retrieving balances, depositing, and withdrawing money (doc/tutorial/07_domain_actions.md).

Advanced Features:

  • Instructions for retrieving saved events and using snapshots to manage the state of the ModelSpace (doc/tutorial/08_event_retrieval.md, doc/tutorial/09_snapshots.md). [1] [2]
  • Demonstrated how to restore ModelSpace via event replay and the automatic synchronization feature (doc/tutorial/10_event_replay.md).
  • Explained the time-traveling feature to explore past states of the ModelSpace (doc/tutorial/11_time_traveling.md).

mumez added 30 commits March 27, 2025 22:13
…vel notifications.

HsDefaultNotifierModel is used internally for ModelSpace level notifications.
@mumez mumez merged commit 603688d into main Apr 14, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant