# sarthakpawar0912/expense-income-tracker architecture

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

- Interactive diagram: https://gitdiagram.com/sarthakpawar0912/expense-income-tracker
- Repository: https://github.com/sarthakpawar0912/expense-income-tracker

## Overview

##### Project Type & Purpose
- This is a **backend-only**, **monolithic** RESTful API built with **Spring Boot 3.1.5** and **Java 17**, using **MySQL** as its persistence store.
- Purpose: Expose endpoints for managing expenses, incomes, and financial analytics (stats/chart).

##### File Structure & Architectural Pattern
- **Layered (MVC) Architecture**
- src/main/java/com/SRP/ExpenseTracker/Controller → REST Controllers (API layer)
- src/main/java/com/SRP/ExpenseTracker/Service → Business logic (Service layer)
- src/main/java/com/SRP/ExpenseTracker/Repository → Data access (Repository/DAO layer)
- src/main/java/com/SRP/ExpenseTracker/entity → JPA Entities (Domain model)
- src/main/java/com/SRP/ExpenseTracker/dto → Data Transfer Objects for API I/O
- **Configuration & Build**
- pom.xml, mvnw → Maven build and dependency management
- src/main/resources/application.properties → DataSource and Spring Boot settings

##### Main Components
a. **Clients** (e.g., Postman, Web Frontend, Mobile App)
b. **API Layer**
- ExpenseController
- IncomeController
- StatsController
c. **Service Layer**
- ExpenseServiceImpl (implements ExpenseService)
- IncomeServiceImpl
- StatsServiceImpl
d. **Repository Layer**
- ExpenseRepository (extends JPA Repository)
- IncomeRepository
e. **Database**
- MySQL instance (finance_db schema)
f. **Supporting Infrastructure**
- Spring Boot Application Context (ExpenseTrackerApplication)
- Maven/Wrapped build process

##### Relationships & Data Flow
1. **Client → Controller**: HTTP requests (POST/GET/PUT/DELETE) to `/api/expense`, `/api/income`, `/api/stats`.
2. **Controller → Service**: Controllers delegate validation and business logic to Service layer.
3. **Service → Repository**: Services call JPA Repositories to perform CRUD.
4. **Repository → Database**: Repositories map Entity objects to MySQL tables via Spring Data JPA.
5. **StatsService** may call both ExpenseRepository and IncomeRepository, aggregate results, and return StatsDTO or GraphDTO.

##### Architectural Patterns & Principles
- **Separation of Concerns**: Controllers handle HTTP and DTO translation; Services contain business logic; Repositories abstract persistence.
- **DTO Pattern**: Prevents exposing Entities directly, eases versioning.
- **Layered Modularity**: Each package clearly delineates responsibility, improving testability (see `src/test/java/...`).

- Clear **layer separation** (API / Service / Data).

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Clients"
        C["Clients"]:::client
    end

    subgraph "API Layer"
        EC["ExpenseController"]:::controller
        IC["IncomeController"]:::controller
        SC["StatsController"]:::controller
    end

    subgraph "Service Layer"
        ESI["ExpenseServiceImpl"]:::service
        ISI["IncomeServiceImpl"]:::service
        SSI["StatsServiceImpl"]:::service
    end

    subgraph "Repository Layer"
        ER["ExpenseRepository"]:::repository
        IR["IncomeRepository"]:::repository
    end

    DB[(MySQL Database)]:::database
    App["ExpenseTrackerApplication"]:::app
    Config["application.properties"]:::config
    Build["pom.xml / mvnw"]:::build

    C -->|"HTTP"| EC
    C -->|"HTTP"| IC
    C -->|"HTTP"| SC

    EC -->|"calls Service"| ESI
    IC -->|"calls Service"| ISI
    SC -->|"calls Service"| SSI

    ESI -->|"JPA CRUD"| ER
    ISI -->|"JPA CRUD"| IR
    SSI -->|"reads from"| ER
    SSI -->|"reads from"| IR

    ER -->|"connects to"| DB
    IR -->|"connects to"| DB

    App -->|"boots Controllers"| EC
    App -->|"boots Services"| ESI
    App -->|"boots Repositories"| ER
    App -->|"uses config"| Config
    Build -->|"builds"| App

    click EC "https://github.com/sarthakpawar0912/expense-income-tracker/blob/main/src/main/java/com/SRP/ExpenseTracker/Controller/ExpenseController.java"
    click IC "https://github.com/sarthakpawar0912/expense-income-tracker/blob/main/src/main/java/com/SRP/ExpenseTracker/Controller/IncomeController.java"
    click SC "https://github.com/sarthakpawar0912/expense-income-tracker/blob/main/src/main/java/com/SRP/ExpenseTracker/Controller/StatsController.java"
    click ESI "https://github.com/sarthakpawar0912/expense-income-tracker/blob/main/src/main/java/com/SRP/ExpenseTracker/Service/Expense/ExpenseServiceImpl.java"
    click ISI "https://github.com/sarthakpawar0912/expense-income-tracker/blob/main/src/main/java/com/SRP/ExpenseTracker/Service/income/IncomeServiceImpl.java"
    click SSI "https://github.com/sarthakpawar0912/expense-income-tracker/blob/main/src/main/java/com/SRP/ExpenseTracker/Service/stats/StatsServiceImpl.java"
    click ER "https://github.com/sarthakpawar0912/expense-income-tracker/blob/main/src/main/java/com/SRP/ExpenseTracker/Repository/ExpenseRepository.java"
    click IR "https://github.com/sarthakpawar0912/expense-income-tracker/blob/main/src/main/java/com/SRP/ExpenseTracker/Repository/IncomeRepository.java"
    click App "https://github.com/sarthakpawar0912/expense-income-tracker/blob/main/src/main/java/com/SRP/ExpenseTracker/ExpenseTrackerApplication.java"
    click Config "https://github.com/sarthakpawar0912/expense-income-tracker/blob/main/src/main/resources/application.properties"
    click Build "https://github.com/sarthakpawar0912/expense-income-tracker/blob/main/pom.xml"

    classDef client fill:#d5c4a1,stroke:#bdae93,color:#3c3836;
    classDef controller fill:#83a598,stroke:#504945,color:#fbf1c7;
    classDef service fill:#b8bb26,stroke:#504945,color:#282828;
    classDef repository fill:#fe8019,stroke:#504945,color:#282828;
    classDef database fill:#fb4934,stroke:#cc241d,color:#fbf1c7,shape:cylinder;
    classDef app fill:#8ec07c,stroke:#504945,color:#1d2021;
    classDef config fill:#689d6a,stroke:#504945,color:#1d2021;
    classDef build fill:#d3869b,stroke:#504945,color:#1d2021;
```
