Skip to content

Commit

Permalink
Update sequence diagrams and AboutUs
Browse files Browse the repository at this point in the history
  • Loading branch information
lckjosh committed Nov 13, 2023
1 parent 74bdfcb commit 97abba0
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 2 deletions.
10 changes: 10 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ documentation with regards to the design and implementation of the App. In addit
we added other related information like the product scope, user stories, non-functional
requirements, glossary and instructions for testing

## Acknowledgements

Referred to [addressbook-level3](https://se-education.org/addressbook-level3/DeveloperGuide.html) when drafting this
Developer Guide.

This project has been heavily modified from [Spaceman Task Manager](https://github.com/spaceman03/ip/).

Thanks to Dr Akshay Narayan (module coordinator) and Irving (TA) for their guidance
throughout the course of this project.

## Design

### Architecture
Expand Down
25 changes: 23 additions & 2 deletions docs/diagrams/ListTransactionSequenceDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Participant ":Nuscents" as nuscents MAIN_COLOR
Participant ":Parser" as parser PARSER_COLOR
Participant ":ListCommand" as ListCommand COMMAND_COLOR
Participant ":TransactionList" as TransactionList UI_COLOR
Participant ":UI" as UI

user -[USER_COLOR]> nuscents
activate nuscents MAIN_COLOR
Expand All @@ -29,15 +30,35 @@ deactivate parser
nuscents -> ListCommand : execute()
activate ListCommand

ListCommand -> TransactionList : getTransactions()
ListCommand -> UI : showTransactionList()
activate UI

UI -> TransactionList : getTransactions()
activate TransactionList

TransactionList --> ListCommand
TransactionList --> UI
deactivate TransactionList

UI --> ListCommand
deactivate UI

ListCommand -> UI : showBudgetExpense()
activate UI

UI -> TransactionList : getBudget()
activate TransactionList

TransactionList --> UI
deactivate TransactionList

UI --> ListCommand
deactivate UI


ListCommand --> nuscents
deactivate ListCommand

nuscents --> user
deactivate nuscents
destroy ListCommand
@enduml
1 change: 1 addition & 0 deletions docs/diagrams/ViewSequenceDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,5 @@ deactivate ViewCommand

nuscents --> user
deactivate nuscents
destroy ViewCommand
@enduml

0 comments on commit 97abba0

Please sign in to comment.