# vivek081202/fintrack-expense_and_budget_analyzer architecture

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

- Interactive diagram: https://gitdiagram.com/vivek081202/fintrack-expense_and_budget_analyzer
- Repository: https://github.com/vivek081202/fintrack-expense_and_budget_analyzer

## Overview

##### Project Type and Purpose
- FinTrack is a command-line, single-executable C application that provides expense tracking, budget management, and basic analytics via file-based persistence. There is no separate frontend server or database—everything runs in one process and reads/writes flat files.

##### File Structure
- Top-level:
- `src/` – C source and headers
- `data/` – sample budgets.txt and expenses.txt
- `docs/` – project synopsis and example outputs
- `README.md`, `LICENSE`
- Inside `src/`:
- `main.c` – entry point, CLI loop
- `fintrack.h` – core logic declarations (sorting, searching, expense & budget functions)
- `output/` – compiled binaries and various user_data text files
- Persistence:
- `user_data.txt`, `<username>_data.txt`, `budgets.txt`, `expenses.txt`

##### Pull Key Insights from README
- Core modules: Expense Tracking, Budget Management, Data Visualization
- Algorithms: Merge Sort, Binary Search
- File-based storage for user data
- Planned enhancements: bank API integration, auth/login not yet implemented

##### Main Components
a. Presentation Layer (CLI UI)
- Login/Register prompts (NEW MODULE)
b. Authentication Module (NEW)
- Functions: registerUser(), loginUser()
- Reads/writes `user_data.txt` entries
c. Business Logic Layer
- ExpenseManager: addExpense(), listExpenses(), sort/Search
- BudgetManager: setBudget(), checkBudgetStatus()
- AnalyticsEngine: generateCharts(), calculateTrends
d. Persistence Layer
- FileStore: fileRead(), fileWrite(), temp file ops
- Data files: `expenses.txt`, `budgets.txt`, `<username>_data.txt`
e. (Optional) External Services
- BankAPIConnector (future) for automatic transaction import

##### Relationships and Data Flow
- On startup → CLI UI shows Login/Register → calls Auth Module
- Auth Module ↔ FileStore → validate or create user record
- Post-login → CLI UI presents main menu → routes commands to ExpenseManager or BudgetManager
- Managers ↔ AnalyticsEngine (for sorting/searching)
- Managers ↔ FileStore → read/write expense & budget files
- AnalyticsEngine → returns stats and chart data back to CLI UI for display

##### Architectural Patterns & Principles
- Modular separation by functionality (Auth, UI, Expense, Budget, Persistence, Analytics)
- Single responsibility per module
- File-based “repository” abstraction hiding raw I/O
- Procedural layering: UI → Business → Persistence
- Future-proof extension points for API integration

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Layer
    CLI_UI["CLI UI\n(beautifulConsole.h)"]:::ui
    click CLI_UI "https://github.com/vivek081202/fintrack-expense_and_budget_analyzer/blob/main/src/beautifulConsole.h"
    click CLI_UI "https://github.com/vivek081202/fintrack-expense_and_budget_analyzer/blob/main/src/main.c"

    %% Authentication Module
    Auth_Module["Authentication Module\nregisterUser(), loginUser()"]:::business
    click Auth_Module "https://github.com/vivek081202/fintrack-expense_and_budget_analyzer/blob/main/src/fintrack.h"

    %% Business Logic Layer
    subgraph "Business Logic" 
        ExpenseManager["ExpenseManager\naddExpense(), listExpenses(), sort/Search"]:::business
        click ExpenseManager "https://github.com/vivek081202/fintrack-expense_and_budget_analyzer/blob/main/src/fintrack.h"
        BudgetManager["BudgetManager\nsetBudget(), checkBudgetStatus()"]:::business
        click BudgetManager "https://github.com/vivek081202/fintrack-expense_and_budget_analyzer/blob/main/src/fintrack.h"
        AnalyticsEngine["AnalyticsEngine\ngenerateCharts(), calculateTrends"]:::business
        click AnalyticsEngine "https://github.com/vivek081202/fintrack-expense_and_budget_analyzer/blob/main/src/fintrack.h"
    end

    %% Persistence Layer
    FileStore["FileStore\nfileRead(), fileWrite(), temp file ops"]:::persistence
    click FileStore "https://github.com/vivek081202/fintrack-expense_and_budget_analyzer/blob/main/src/fintrack.h"

    %% Data Files
    UserDataFile[/user_data.txt/]:::data
    click UserDataFile "https://github.com/vivek081202/fintrack-expense_and_budget_analyzer/blob/main/src/user_data.txt"
    ExpensesFile[/expenses.txt/]:::data
    click ExpensesFile "https://github.com/vivek081202/fintrack-expense_and_budget_analyzer/blob/main/data/expenses.txt"
    BudgetsFile[/budgets.txt/]:::data
    click BudgetsFile "https://github.com/vivek081202/fintrack-expense_and_budget_analyzer/blob/main/data/budgets.txt"
    DataDir["Data Directory\n(data/)"]:::persistence
    click DataDir "https://github.com/vivek081202/fintrack-expense_and_budget_analyzer/tree/main/data/"
    OutputDir["Output Directory\n(src/output/)"]:::persistence
    click OutputDir "https://github.com/vivek081202/fintrack-expense_and_budget_analyzer/tree/main/src/output/"

    %% External Services
    BankAPI["Bank API Connector\n(future)"]:::external

    %% Connections
    CLI_UI -->|"loginUser()/registerUser()"| Auth_Module
    Auth_Module -->|"fileRead()/fileWrite()"| FileStore
    FileStore -.->|reads/writes| UserDataFile

    CLI_UI -->|"addExpense()/listExpenses()"| ExpenseManager
    CLI_UI -->|"setBudget()/checkBudgetStatus()"| BudgetManager
    CLI_UI -->|"viewAnalytics()"| AnalyticsEngine

    ExpenseManager -->|"fileRead()/fileWrite()"| FileStore
    BudgetManager -->|"fileRead()/fileWrite()"| FileStore
    AnalyticsEngine -->|"calls sort/search algos"| ExpenseManager
    AnalyticsEngine -->|"calls sort/search algos"| BudgetManager

    FileStore -.->|reads/writes| ExpensesFile
    FileStore -.->|reads/writes| BudgetsFile

    ExpenseManager --> AnalyticsEngine
    BudgetManager --> AnalyticsEngine

    FileStore --> DataDir
    FileStore --> OutputDir

    CLI_UI --> BankAPI

    %% Styles
    classDef ui fill:#cce5ff,stroke:#66b0ff,color:#004085;
    classDef business fill:#d4edda,stroke:#28a745,color:#155724;
    classDef persistence fill:#fff3cd,stroke:#ffc107,color:#856404;
    classDef data fill:#e2e3e5,stroke:#d6d8db,color:#6c757d;
    classDef external fill:#f8d7da,stroke:#dc3545,color:#721c24;
```
