# longnguyenvu24/it4883q_project_group5 architecture

> Architecture diagram of the GitHub repository longnguyenvu24/it4883q_project_group5, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/longnguyenvu24/it4883q_project_group5
- Repository: https://github.com/longnguyenvu24/it4883q_project_group5

## Overview

##### Project Type and Purpose
- This project is an open source Task-Manager application focused on managing tasks with features like theming, customizable keyboard shortcuts, task categorization, reminders, and file attachments.
- That this repository contains the front-end part (FE) of the application built using Angular (as evident from angular.json, TypeScript files, and the “WorkManage/src” structure). The backend (API) is maintained separately.

##### Main Components
a. Frontend:
- The Angular application (located under “WorkManage/”) which contains various UI components like home page, login, task lists, dialogs (for editing tasks, settings, etc.), sidebar, notifications, and more.
- Separation of components (e.g., completed tasks, login flows, list view, process view, and user management) as seen under “WorkManage/src/app/components”.

b. CI/CD Pipeline:
- The GitHub Actions workflow (see “.github/workflows/main.yml”) which is configured to checkout the repo, build the Docker image from the Dockerfile in “WorkManage/Dockerfile”, and push the image to Docker Hub.
- Automation of building, testing, and deployment steps.

c. Docker & Containerization:
- The Dockerfile and related configuration (e.g., .dockerignore) indicate containerization of the FE.
- A “Docker Image” component that results from the CI/CD process and eventually is deployed on a container runtime.

d. Backend Integration:
- REST API endpoints, authentication, or data interactions between the FE and backend.

e. External Services & Integrations:
- Integration components mentioned, such as file attachments (img, wav, etc.) and third-party integration (e.g., Google integration for syncing or authentication).

##### Relationships and Interactions
- Optionally, include feedback loops such as update notifications from the backend to the FE.

##### Architectural Patterns and Design Principles
- Modular UI Design: The component-based structure (e.g., login, list, task, sidebar) shows that the application is highly modular.
- Separation of Concerns: Frontend UI is separated from business logic/services (e.g., process.service.ts, task.service.ts) which handle communication with the API.
- Containerization & Automation: The use of Docker for packaging the FE and GitHub Actions for CI/CD illustrates modern DevOps practices.
- Scalability: Emphasize that the FE is designed to scale (as noted by the “Scalable Interface” highlight) and integrates with the backend and external services.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Nodes for Build/Deploy Pipeline
    SR["Source Repository"]:::cicd
    CICD["CI/CD Pipeline (GitHub Actions)"]:::cicd
    subgraph "Docker & Containerization"
        DF["Dockerfile"]:::docker
        DC[".dockerignore"]:::docker
    end
    DCI["Docker Container Image"]:::docker
    CR["Container Runtime/Hosting"]:::docker

    %% Nodes for Frontend and Backend
    subgraph "Frontend"
        FE["Angular Frontend Application"]:::frontend
        UI["UI Components"]:::frontend
    end
    BE["Backend API Service (Separate Repo)"]:::backend
    EI["External Integrations"]:::external

    %% Connections for Build/Deploy Pipeline
    SR -->|"BuildTrigger"| CICD
    CICD -->|"Build&PUSH"| DCI
    DF --> DCI
    DC --> DCI
    DCI -->|"Deployment"| CR

    %% Connections for Application Flow
    FE -->|"API_Call"| BE
    BE -->|"Response"| FE
    FE -->|"Integrates"| EI
    FE -->|"contains"| UI

    %% Click Events
    click FE "https://github.com/longnguyenvu24/it4883q_project_group5/tree/main/WorkManage/src/app"
    click UI "https://github.com/longnguyenvu24/it4883q_project_group5/tree/main/WorkManage/src/app/components"
    click CICD "https://github.com/longnguyenvu24/it4883q_project_group5/blob/main/.github/workflows/main.yml"
    click DF "https://github.com/longnguyenvu24/it4883q_project_group5/tree/main/WorkManage/Dockerfile"
    click DC "https://github.com/longnguyenvu24/it4883q_project_group5/blob/main/WorkManage/.dockerignore"

    %% Styles
    classDef frontend fill:#b3e5fc,stroke:#0288d1,stroke-width:2px;
    classDef cicd fill:#c8e6c9,stroke:#2e7d32,stroke-width:2px;
    classDef docker fill:#fff9c4,stroke:#fbc02d,stroke-width:2px;
    classDef backend fill:#ffcdd2,stroke:#c62828,stroke-width:2px;
    classDef external fill:#d1c4e9,stroke:#6a1b9a,stroke-width:2px;
```
