# parthnagdev/efforttracker architecture

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

- Interactive diagram: https://gitdiagram.com/parthnagdev/efforttracker
- Repository: https://github.com/parthnagdev/efforttracker

## Overview

##### Project type and purpose
- This is a full-stack web application called “EffortTracker”:
- Frontend: React + TypeScript single-page application (SPA).
- Backend: Java Spring Boot REST API.
- OpenAPI specs for API contract and autogenerated TS client.
- Purpose: allow users to create, assign, estimate, track, filter tasks and generate reports.

##### File structure
- Top-level:
- backend/ — Spring Boot service:
– build.gradle, Dockerfile, gradlew scripts
– src/main/java: MVC layers (config, controller, filter, storage, tracker)
– application.properties
- frontend/ — React SPA:
– package.json, Tailwind CSS config, OpenAPI client generation setup
– public/: static assets and index.html
– src/: API client (src/api), components (forms, tables, navbar), pages, routes
- openapi/ — YAML spec and collection.json for API definition
- Deployment files:
- frontend/.github/workflows/ci-cd.yml for CI/CD
- backend/Dockerfile + AWS ECR/ECS/EKS deployment steps in README

##### README for additional insights
- Functional requirements: CRUD on tasks & users, task hierarchies, filtering, reporting.
- Deployment:
- Frontend → AWS Amplify (static-hosting).
- Backend → Docker → AWS ECR → EC2 container.

##### Main components
a. Client Layer:
– Browser (SPA UI)
– React Router, Redux or context (if used)
b. Presentation Layer:
– AWS Amplify hosting → serves static React assets
c. API Layer:
– Spring Boot REST controllers (EffortTrackingController, ProjectController, UserController)
– OpenAPI spec enforcement
d. Business Logic Layer:
– EffortTracker service classes
e. Data Access Layer:
– DbClient (storage), DatabaseConfig (JDBC/DataSource)
– Underlying relational database (e.g., Amazon RDS)
f. External Services:
– AWS Amplify, AWS ECR, AWS EC2
– (Optional) Authentication provider if used (e.g., Cognito)
g. DevOps/CI:
– GitHub Actions for frontend CI/CD
– Gradle build tasks, Docker builds for backend

##### Relationships and interactions
- User’s browser issues HTTP(S) requests to the React app; app invokes REST API:
Browser → (HTTPS) → Amplify-hosted React → (HTTPS/JSON) → Spring Boot API
- Spring Boot service handles requests via Controllers → calls EffortTracker logic → DbClient
→ relational DB → returns data → Controllers → JSON response → React UI
- OpenAPI spec governs request/response schemas; API client in frontend generated from it.
- CI/CD: pushes to GitHub → workflows build & deploy frontend to Amplify; backend built via Gradle → Docker image → pushed to ECR → pulled by EC2 instance.

##### Architectural patterns and design principles
- 3-tier architecture (Presentation / Application / Data)
- MVC pattern in Spring Boot (Controller → Service → Repository)
- Separation of concerns:
- CORS filter isolated in filter package
- Configuration in config package
- API client code autogenerated under frontend/src/api
- Stateless REST API for horizontal scalability

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        Browser["User Browser"]:::frontend
        ReactSPA["React SPA"]:::frontend
        Router["React Router"]:::frontend
        APIClient["OpenAPI TS Client"]:::frontend
    end

    %% Presentation Hosting
    Amplify["AWS Amplify"]:::infra

    %% API Contract
    OpenAPISpec["OpenAPI Spec"]:::contract

    %% Backend Layer
    subgraph "Backend Layer"
        direction TB
        SpringBoot["EffortTrackerApplication"]:::backend
        subgraph "Controllers"
            direction TB
            EffortTrackingController["EffortTrackingController"]:::backend
            ProjectController["ProjectController"]:::backend
            UserController["UserController"]:::backend
        end
        SimpleCORSFilter["SimpleCORSFilter"]:::backend
        DatabaseConfig["DatabaseConfig"]:::backend
        EffortTrackerService["EffortTracker Service"]:::backend
        DbClient["DbClient"]:::backend
    end

    %% Database
    RDS["Amazon RDS"]:::database

    %% Infrastructure & CI/CD
    subgraph "CI/CD & Infra"
        direction TB
        GitHubActions["GitHub Actions"]:::ci
        ECR["AWS ECR"]:::infra
        EC2["AWS EC2"]:::infra
        DockerBuild["Backend Docker Build"]:::ci
    end

    %% Flow Connections
    Browser -->|"loads SPA"| Amplify
    Amplify -->|"serves static assets"| ReactSPA
    ReactSPA -->|"navigates"| Router
    ReactSPA -->|"calls API"| APIClient
    APIClient -->|"HTTPS JSON"| OpenAPISpec
    OpenAPISpec -->|"defines contract"| SpringBoot

    SpringBoot --> SimpleCORSFilter
    SpringBoot --> EffortTrackingController
    SpringBoot --> ProjectController
    SpringBoot --> UserController

    EffortTrackingController --> EffortTrackerService
    ProjectController --> EffortTrackerService
    UserController --> EffortTrackerService

    EffortTrackerService --> DbClient
    DbClient --> DatabaseConfig
    DbClient --> RDS

    %% CI/CD Flows
    GitHubActions -->|"build & deploy Frontend"| Amplify
    GitHubActions -->|"build Backend Docker image"| DockerBuild
    DockerBuild --> ECR
    EC2 -->|"pull image from ECR"| ECR
    EC2 --> SpringBoot

    %% Click Events
    click ReactSPA "https://github.com/parthnagdev/efforttracker/blob/main/frontend/src/index.tsx"
    click Router "https://github.com/parthnagdev/efforttracker/blob/main/frontend/src/routes/index.tsx"
    click APIClient "https://github.com/parthnagdev/efforttracker/blob/main/frontend/src/api/api.ts"
    click SpringBoot "https://github.com/parthnagdev/efforttracker/blob/main/backend/src/main/java/com/efforttracker/app/EffortTrackerApplication.java"
    click EffortTrackingController "https://github.com/parthnagdev/efforttracker/blob/main/backend/src/main/java/com/efforttracker/app/controller/EffortTrackingController.java"
    click ProjectController "https://github.com/parthnagdev/efforttracker/blob/main/backend/src/main/java/com/efforttracker/app/controller/ProjectController.java"
    click UserController "https://github.com/parthnagdev/efforttracker/blob/main/backend/src/main/java/com/efforttracker/app/controller/UserController.java"
    click EffortTrackerService "https://github.com/parthnagdev/efforttracker/blob/main/backend/src/main/java/com/efforttracker/app/tracker/EffortTracker.java"
    click DbClient "https://github.com/parthnagdev/efforttracker/blob/main/backend/src/main/java/com/efforttracker/app/storage/DbClient.java"
    click DatabaseConfig "https://github.com/parthnagdev/efforttracker/blob/main/backend/src/main/java/com/efforttracker/app/config/DatabaseConfig.java"
    click SimpleCORSFilter "https://github.com/parthnagdev/efforttracker/blob/main/backend/src/main/java/com/efforttracker/app/filter/SimpleCORSFilter.java"
    click OpenAPISpec "https://github.com/parthnagdev/efforttracker/blob/main/openapi/specs.yml"
    click GitHubActions "https://github.com/parthnagdev/efforttracker/blob/main/frontend/.github/workflows/ci-cd.yml"
    click DockerBuild "https://github.com/parthnagdev/efforttracker/tree/main/backend/Dockerfile"

    %% Styles
    classDef frontend fill:#D6E9FE,stroke:#0366d6,color:#0366d6;
    classDef backend fill:#E8F5E9,stroke:#388E3C,color:#388E3C;
    classDef database fill:#FFF3E0,stroke:#FB8C00,color:#FB8C00;
    classDef infra fill:#E3F2FD,stroke:#1976D2,color:#1976D2;
    classDef ci fill:#F3E5F5,stroke:#8E24AA,color:#8E24AA;
    classDef contract fill:#FBE9E7,stroke:#D84315,color:#D84315;
```
