kambed / OpinionCollectorArchitecture

OpinionCollector - Project Architecture for TUL project

System architecture

Designed with PlantUML

Components diagram

@startuml
component Frontend {
    component UserPanel {
    }
    
    component AdminPanel {
    }
    
    component BackendCommunication {
    }
}

component Backend {
    component UserLogic {
    }
    component ProductLogic {
    }
    component OpinionLogic {
    }
    component SuggestionLogic {
    }
    
    component DatabaseCommunication {
    }
}

component Database {
}

DatabaseCommunication -(0- Database: SQL

UserLogic             -(0- DatabaseCommunication : DatabaseCommunication
ProductLogic          -(0- DatabaseCommunication : DatabaseCommunication
OpinionLogic          -(0- DatabaseCommunication : DatabaseCommunication
SuggestionLogic       -(0- DatabaseCommunication : DatabaseCommunication

BackendCommunication  -(0- UserLogic       : Users
BackendCommunication  -(0- ProductLogic    : Products
BackendCommunication  -(0- OpinionLogic    : Opinions
BackendCommunication  -(0- SuggestionLogic : Sugestions

ProductLogic          -(0- UserLogic : UserAuth
OpinionLogic          -(0- UserLogic : UserAuth
SuggestionLogic       -(0- UserLogic : UserAuth

UserPanel             -(0- BackendCommunication : BackendCommunication
AdminPanel            -(0- BackendCommunication : BackendCommunication

@enduml 

Packages diagram

@startuml
package Frontend {
    package UserView {
        package UserRegistration
        package UserLogin
        package UserPanel {
            package UserData
            package UserOpinions
            package UserSuggestions
        }
        package ProductDetailPage
        package ProductListPage
    }
    
    package AdminView {
        package Products
        package Categories
        package Suggestions
        package Users
    }
    
    package BackendCommunication {
        package GetRequests
        package PostRequests
        package PutRequests
        package DeleteRequests
    }
}

package Backend {
    package UserLogic {
        package User
        package Security
    }
    package ProductLogic {
        package Category
        package Product
    }
    package OpinionLogic {
    }
    package SuggestionLogic {
    }
    
    package DatabaseCommunication {
        package Category as DbCategory
        package Opinion as DbOpinion
        package Product as DbProduct
        package Suggestion as DbSuggestion
        package User as DbUser
    }
}

package Database

AdminView ..> BackendCommunication : <<import>>

UserRegistration  ...> PostRequests : <<import>>
UserLogin         ...> PostRequests : <<import>>
UserOpinions      ...> GetRequests  : <<import>>
UserSuggestions   ...> GetRequests  : <<import>>
ProductListPage   ...> GetRequests  : <<import>>
ProductDetailPage ...> GetRequests  : <<import>>
ProductDetailPage ...> PostRequests : <<import>>

BackendCommunication ...> User            : <<import>>
BackendCommunication ...> Category        : <<import>>
BackendCommunication ...> Product         : <<import>>
BackendCommunication ...> OpinionLogic    : <<import>>
BackendCommunication ...> SuggestionLogic : <<import>>

User            ...> Security : <<import>>
Category        ...> Security : <<import>>
Product         ...> Security : <<import>>
OpinionLogic    ...> Security : <<import>>
SuggestionLogic ...> Security : <<import>>

User            ...> DatabaseCommunication : <<import>>
Security            ...> DatabaseCommunication : <<import>>
Category        ...> DatabaseCommunication : <<import>>
Product         ...> DatabaseCommunication : <<import>>
OpinionLogic    ...> DatabaseCommunication : <<import>>
SuggestionLogic ...> DatabaseCommunication : <<import>>

DbCategory   ...> Database : <<import>>
DbOpinion    ...> Database : <<import>>
DbProduct    ...> Database : <<import>>
DbSuggestion ...> Database : <<import>>
DbUser       ...> Database : <<import>>

@enduml 

Deployment diagram

@startuml

node "Database Server" <<device>> as database {
    component Database
}
node Server <<device>> as server {
    component Backend {
        component UserLogic {
        }
        component ProductLogic {
        }
        component OpinionLogic {
        }
        component SuggestionLogic {
        }
        
        component DatabaseCommunication {
        }
    }
}
node Browser as browser {
    component Frontend {
        component UserPanel {
        }
        
        component AdminPanel {
        }
        
        component BackendCommunication {
        }
    }
}

DatabaseCommunication -(0- Database: SQL

UserLogic             -(0- DatabaseCommunication : DatabaseCommunication
ProductLogic          -(0- DatabaseCommunication : DatabaseCommunication
OpinionLogic          -(0- DatabaseCommunication : DatabaseCommunication
SuggestionLogic       -(0- DatabaseCommunication : DatabaseCommunication

BackendCommunication  -(0- UserLogic       : Users
BackendCommunication  -(0- ProductLogic    : Products
BackendCommunication  -(0- OpinionLogic    : Opinions
BackendCommunication  -(0- SuggestionLogic : Logics

ProductLogic          -(0- UserLogic : UserAuth
OpinionLogic          -(0- UserLogic : UserAuth
SuggestionLogic       -(0- UserLogic : UserAuth

UserPanel             -(0- BackendCommunication : BackendCommunication
AdminPanel            -(0- BackendCommunication : BackendCommunication

@enduml 

Usages diagrams

Not logged in user

@startuml

left to right direction

actor "Not logged in user" AS customer

rectangle Application {
    customer -- (Manage user)
    customer -- (Search products)
    customer -- (Browse product)
    
    (Manage user) <.. (Register): <<extend>>
    (Manage user) <.. (Log in): <<extend>>
    
    (Search products) <.. (Display visible products list): <<extend>>
    (Search products) <.. (Filter visible products list): <<extend>>
    
    (Browse product) <.. (Display product details): <<extend>>
    (Browse product) <.. (Display product opinions): <<extend>>
}

@enduml

Logged in user

@startuml

left to right direction

actor "Logged in user" AS customer

rectangle Application {
    customer -- (Search products)
    customer -- (Manage user)
    customer -- (Browse product)
    
    (Search products) <.. (Display visible products list): <<extend>>
    (Search products) <.. (Filter visible products list): <<extend>>
    
    (Browse product) <.. (Display product details): <<extend>>
    (Browse product) <.. (Display product opinions): <<extend>>
    (Browse product) <.. (Add opinion): <<extend>>
    (Browse product) <.. (Add suggestions): <<extend>>
    
    (Manage user) <.. (Display user suggestions): <<extend>>
    (Manage user) <.. (Display user opinions): <<extend>>
}

@enduml

Logged in admin user

@startuml

left to right direction

actor Admin AS admin

rectangle Application {
    admin -- (Search products)
    admin -- (Browse product)
    admin --  (Administer users)
    admin --  (Administer products)
    admin --  (Administer categories)
    admin --  (Administer suggestions)
    
    (Search products) <.. (Display visible products list): <<extend>>
    (Search products) <.. (Filter visible products list): <<extend>>
    
    (Browse product) <.. (Display product details): <<extend>>
    (Browse product) <.. (Display product opinions): <<extend>>
    
    (Administer users) <.. (Display users list): <<extend>>
    (Administer users) <.. (Edit user): <<extend>>
    (Administer users) <.. (Add user): <<extend>>
    
    (Administer products) <.. (Display products list): <<extend>>
    (Administer products) <.. (Add product): <<extend>>
    (Administer products) <.. (Edit product): <<extend>>
    (Administer products) <.. (Remove product): <<extend>>
    
    (Administer categories) <.. (Display category list): <<extend>>
    (Administer categories) <.. (Add category): <<extend>>
    (Administer categories) <.. (Edit category): <<extend>>
    (Administer categories) <.. (Remove category): <<extend>>
    
    (Administer suggestions) <.. (Display suggestions list): <<extend>>
    (Administer suggestions) <.. (React to suggestion): <<extend>>
}

@enduml