# arjunastrw/project-management-hub architecture

> Architecture diagram of the GitHub repository arjunastrw/project-management-hub, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/arjunastrw/project-management-hub
- Repository: https://github.com/arjunastrw/project-management-hub

## Overview

##### Project Type and Purpose
- This is a monolithic, full-stack backend service written in Go.
- Purpose: Provide RESTful APIs for project, task, report, and user management; handle authentication via JWT; persist data in a relational database and file storage; generate and expose reports; integrate with external productivity tools.

##### File Structure
- Top-level components (packages/directories):
- main.go / server.go: Application entrypoint and HTTP server.
- config: DB connection, raw SQL queries.
- delivery: HTTP layer (controllers, middleware).
- usecase: Business logic, orchestrates domain operations.
- repository: Data persistence (DB and file-based).
- model: Domain entities and DTOs.
- shared: Common utilities (JSON responses, JWT service, pagination models).
- report: Report generation logic and result storage.
- mock: Test doubles for unit tests.
- sql: DDL/DML scripts.
- Dockerfile / docker-compose.yml: Containerization.

##### README for Additional Insights
- Core features: task management, collaboration, resource allocation, progress tracking, document management, integrations.
- External integrations: Slack, Jira, Google Workspace (depicted as optional external services).

##### Main Components & Their Relationships
a. Clients & Entry Points
- Web/mobile UIs or API clients → send HTTP(S) requests.
- Entrypoint: docker-compose or main.go spins up HTTP server (delivery/server.go).
b. Delivery Layer
- HTTP Server
- Middleware (auth_middleware.go): validates JWT tokens, injects user context.
- Controllers (auth, user, project, task, report): parse requests, call UseCase layer, format responses.
c. UseCase Layer
- auth_usecase, user_usecase, project_usecase, task_usecase, report_usecase: implement business rules, coordinate domain operations.
d. Repository Layer
- project_repository, user_repository, task_repository, report_repository: CRUD operations.
- Underlying stores:
- SQL database (DDL/DML under sql/; configured in config/config.go).
- File storage for report artifacts (repository/file dir path).
e. Shared Services & Models
- JWT Service (shared/service/jwt_service.go)
- JSON response builder (shared/common/json_response.go)
- Shared data models (pagination_model, jwt_model, json_model).
f. Report Module
- report_function.go: composes data from UseCase + repository, writes report files under report/report-result.
g. External Integrations (optional)
- Slack, Jira, Google Workspace as “External Services” if invoked (not present in code, but noted in README).

##### Architectural Patterns & Design Principles
- Layered (Onion/Clean) Architecture:
- Delivery (UI/API) → UseCase (Domain) → Repository (Persistence)
- Separation of concerns: each package has a well-defined role.
- Dependency direction: outer layers depend on inner layers (controllers → usecases → repositories).
- Testability: mocks for middleware, repository, and usecase layers.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients
    subgraph "Clients"
        Clients["Web/Mobile UI\n(API Client)"]:::external
    end

    %% Configuration
    subgraph "Configuration"
        Config["Config Module"]:::shared
        RawQuery["Raw SQL Queries"]:::shared
    end

    %% Delivery Layer
    subgraph "Delivery Layer"
        Server["HTTP Server"]:::delivery
        AuthMiddleware["Auth Middleware"]:::delivery
        AuthController["AuthController"]:::delivery
        UserController["UserController"]:::delivery
        ProjectController["ProjectController"]:::delivery
        TaskController["TaskController"]:::delivery
        ReportController["ReportController"]:::delivery
    end

    %% UseCase Layer
    subgraph "UseCase Layer"
        AuthUseCase["AuthUseCase"]:::usecase
        UserUseCase["UserUseCase"]:::usecase
        ProjectUseCase["ProjectUseCase"]:::usecase
        TaskUseCase["TaskUseCase"]:::usecase
        ReportUseCase["ReportUseCase"]:::usecase
    end

    %% Repository Layer
    subgraph "Repository Layer"
        UserRepo["UserRepository"]:::repository
        ProjectRepo["ProjectRepository"]:::repository
        TaskRepo["TaskRepository"]:::repository
        ReportRepo["ReportRepository"]:::repository
        FileStorage["Report File Storage"]:::data
    end

    %% Shared Services & Models
    subgraph "Shared Utilities"
        JSONResp["JSON Response Builder"]:::shared
        JWTService["JWT Service"]:::shared
        JSONModel["JSON Models"]:::shared
        JWTModel["JWT Models"]:::shared
        PaginationModel["Pagination Models"]:::shared
    end

    %% Data Stores
    subgraph "Data Stores"
        SQLDB["SQL Database"]:::data
    end

    %% Report Module
    subgraph "Reporting Module"
        ReportFunc["Report Function"]:::usecase
    end

    %% External Integrations
    subgraph "External Services"
        Slack["Slack"]:::external
        Jira["Jira"]:::external
        GoogleWS["Google Workspace"]:::external
    end

    %% Deployment
    subgraph "Deployment"
        Docker["Docker / docker-compose"]:::external
    end

    %% Connections
    Clients -->|"HTTP Request"| Server
    Server --> AuthMiddleware
    AuthMiddleware -->|Validates JWT| AuthController
    Server --> AuthController
    Server --> UserController
    Server --> ProjectController
    Server --> TaskController
    Server --> ReportController

    AuthController -->|"calls"| AuthUseCase
    UserController --> UserUseCase
    ProjectController --> ProjectUseCase
    TaskController --> TaskUseCase
    ReportController --> ReportUseCase

    AuthUseCase --> JWTService
    AuthUseCase --> UserRepo

    UserUseCase --> UserRepo
    ProjectUseCase --> ProjectRepo
    TaskUseCase --> TaskRepo
    ReportUseCase --> ReportRepo
    ReportUseCase --> ReportFunc

    ReportFunc --> FileStorage
    ReportFunc --> SQLDB

    UserRepo --> SQLDB
    ProjectRepo --> SQLDB
    TaskRepo --> SQLDB
    ReportRepo --> SQLDB

    Config --> SQLDB
    Config --> RawQuery
    RawQuery --> SQLDB

    JSONResp --> AuthController
    JSONResp --> UserController
    JSONResp --> ProjectController
    JSONResp --> TaskController
    JSONResp --> ReportController

    JSONModel --> JSONResp
    JWTModel --> JWTService
    PaginationModel --> UserController

    ReportUseCase --> JSONResp

    %% External integrations optional
    ReportUseCase -.->|Optional| Slack
    ReportUseCase -.->|Optional| Jira
    ReportUseCase -.->|Optional| GoogleWS

    Docker --> Server

    %% Click Events
    click Server "https://github.com/arjunastrw/project-management-hub/blob/main/main.go"
    click Server "https://github.com/arjunastrw/project-management-hub/blob/main/delivery/server.go"
    click Config "https://github.com/arjunastrw/project-management-hub/blob/main/config/config.go"
    click RawQuery "https://github.com/arjunastrw/project-management-hub/blob/main/config/raw_query.go"
    click AuthController "https://github.com/arjunastrw/project-management-hub/blob/main/delivery/controller/auth_controller.go"
    click UserController "https://github.com/arjunastrw/project-management-hub/blob/main/delivery/controller/user_controller.go"
    click ProjectController "https://github.com/arjunastrw/project-management-hub/blob/main/delivery/controller/project_controller.go"
    click TaskController "https://github.com/arjunastrw/project-management-hub/blob/main/delivery/controller/task_controller.go"
    click ReportController "https://github.com/arjunastrw/project-management-hub/blob/main/delivery/controller/report_controller.go"
    click AuthMiddleware "https://github.com/arjunastrw/project-management-hub/blob/main/delivery/middleware/auth_middleware.go"
    click AuthUseCase "https://github.com/arjunastrw/project-management-hub/blob/main/usecase/auth_usecase.go"
    click UserUseCase "https://github.com/arjunastrw/project-management-hub/blob/main/usecase/user_usecase.go"
    click ProjectUseCase "https://github.com/arjunastrw/project-management-hub/blob/main/usecase/project_usecase.go"
    click TaskUseCase "https://github.com/arjunastrw/project-management-hub/blob/main/usecase/task_usecase.go"
    click ReportUseCase "https://github.com/arjunastrw/project-management-hub/blob/main/usecase/report_usecase.go"
    click UserRepo "https://github.com/arjunastrw/project-management-hub/blob/main/repository/user_repository.go"
    click ProjectRepo "https://github.com/arjunastrw/project-management-hub/blob/main/repository/project_repository.go"
    click TaskRepo "https://github.com/arjunastrw/project-management-hub/blob/main/repository/task_repository.go"
    click ReportRepo "https://github.com/arjunastrw/project-management-hub/blob/main/repository/report_repository.go"
    click FileStorage "https://github.com/arjunastrw/project-management-hub/tree/main/repository/file dir path/"
    click JSONResp "https://github.com/arjunastrw/project-management-hub/blob/main/shared/common/json_response.go"
    click JWTService "https://github.com/arjunastrw/project-management-hub/blob/main/shared/service/jwt_service.go"
    click JSONModel "https://github.com/arjunastrw/project-management-hub/blob/main/shared/shared_model/json_model.go"
    click JWTModel "https://github.com/arjunastrw/project-management-hub/blob/main/shared/shared_model/jwt_model.go"
    click PaginationModel "https://github.com/arjunastrw/project-management-hub/blob/main/shared/shared_model/pagination_model.go"
    click ReportFunc "https://github.com/arjunastrw/project-management-hub/blob/main/report/report_function.go"
    click FileStorage "https://github.com/arjunastrw/project-management-hub/tree/main/report/report-result/"
    click SQLDB "https://github.com/arjunastrw/project-management-hub/blob/main/sql/DDL.sql"
    click SQLDB "https://github.com/arjunastrw/project-management-hub/blob/main/sql/DML.sql"
    click Docker "https://github.com/arjunastrw/project-management-hub/tree/main/Dockerfile"
    click Docker "https://github.com/arjunastrw/project-management-hub/blob/main/docker-compose.yml"

    %% Styles
    classDef delivery fill:#D0E9FF,stroke:#004085
    classDef usecase fill:#DFF0D8,stroke:#3C763D
    classDef repository fill:#FCF8E3,stroke:#8A6D3B
    classDef data fill:#E5E5E5,stroke:#555555
    classDef shared fill:#F2DEFF,stroke:#6F42C1
    classDef external fill:#F5F5F5,stroke:#888888,stroke-dasharray: 2 2
```
