How ay2425s2-cs2103t-t13-1/tp works
Main Components
• Frontend/UI Module: Located in the “src/main/java/seedu/address/ui” package and supported by FXML files under “src/main/resources/view”. This component includes all the visual elements (e.g., MainWindow, CommandBox, ResultDisplay) which handle user interactions.
• Business Logic Layer: Found in “src/main/java/seedu/address/logic” along with command classes (like AddCommand, EditCommand, DeleteCommand) and parsers. This module processes user commands and orchestrates the flow of data between the UI and the model.
• Domain/Model Layer: Provided by “src/main/java/seedu/address/model” which represents the underlying data structures such as Person, AddressBook, Schedule, and related exceptions; these capture the business data and rules.
• Storage Module: Evident in “src/main/java/seedu/address/storage”, responsible for persisting data (using JSON files, for example). This includes file handling and the management of user preferences.
• Configuration/Supporting Modules: There are configuration files such as “build.gradle”, checkstyle configurations in “config/checkstyle”, and Gradle wrapper files to support building, coding standards, and project management.
Relationships and Interactions
– From the UI module to the Logic module: representing user input and command processing.
– From the Logic to Model: showing how commands interact with domain objects.
– From the Model to Storage: illustrating saving/loading of data.
• The Logic module also interacts with utility classes (e.g., in the “commons/util” package), so include a link or note for these helper components.
Architectural Patterns and Design Principles
• MVC/Separation of Concerns: Clearly demarcate the UI, logic, and model layers.
• Command Pattern: Within the logic layer, note how various Command classes encapsulate user actions.
• Exception Handling and Utility Classes: Point out that dedicated exceptions and utility classes are available to support the core functionality.
• Use of Gradle build scripts for dependency management and automation.
Deployment/Build Aspects
• Although not the focus of system design, the existence of continuous integration (CI) workflows (e.g., GitHub Actions in “.github/workflows/gradle.yml”) should be noted as part of the overall project architecture so that future maintainers understand the build and deployment pipeline.