# mohamedaminefairouk/comptasync architecture

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

- Interactive diagram: https://gitdiagram.com/mohamedaminefairouk/comptasync
- Repository: https://github.com/mohamedaminefairouk/comptasync

## Overview

##### Project type and purpose
- This is a full-stack accounting application (“ComptaSync”) composed of:
- A Spring Boot backend (REST API for transaction import, ledger management, report generation & export)
- A React + TypeScript frontend (UI for uploading files, viewing transactions and reports, managing templates)

##### File structure
- Top level:
- ComptaSync-Back: Maven/Spring Boot project
– src/main/java/com/project/comptabilite: MVC layering (controller, service, repository, model, dto, config, exception, util)
– application.yml, SwaggerConfig, JacksonConfig for API docs and JSON/XML/CSV binding
– Tests under src/test
- ComptaSync-Front: React + TS
– src/api: Axios client & accountingService wrappers
– src/redux: Redux Toolkit slices & store
– src/components: reusable UI components (Dashboard, UploadFile, Report, TransactionList, etc.)
– src/hooks, src/utils, src/models, src/styles
– Jest + Testing Library tests

##### README
- Backend: supports JSON/XML/CSV import (Jackson, Commons CSV), balanced transactions, balance sheet & income statement generation, Excel export (Apache POI), documented via Swagger, TDD
- Frontend: React Router, memoization, lazy loading, template management in Redux, msw for API mocks

a. Main components
- Browser (React SPA)
- React App layers:
– UI Components
– Hooks & Utils
– Redux Store & Slices
– HTTP Client (apiClient + accountingService)
- Backend REST API (Spring Boot):
– Controllers
– Services (AccountingService, ReportService, ReportExportService)
– Repositories (JPA Repos for GeneralLedgerEntry, Report)
– Config modules (JacksonConfig, SwaggerConfig)
– Exception handling
- Database (relational, e.g., PostgreSQL/MySQL)
- File formats & libraries: JSON, XML, CSV parsers, Excel exporter
- External: Swagger UI

b. Relationships & interactions
- User → Browser → React components
- React components dispatch actions → Redux store → trigger API calls via axios
- API calls (GET/POST) → Spring Boot controllers → service layer → repository → database
- Report export request → service layer uses Apache POI → returns file stream
- Swagger UI served from Spring Boot

c. Architectural patterns and design principles
- Backend: MVC (Controller → Service → Repository) + layered architecture
- Frontend: Component-based UI + Flux (Redux) for state management + hooks for side-effects
- Separation of concerns (import vs. report generation vs. export)
- TDD across both tiers

d. Technologies, frameworks, libraries
- Backend: Java/Kotlin, Spring Boot, Spring Data JPA, Jackson, Apache Commons CSV, Apache POI, Swagger
- Frontend: React, TypeScript, Redux Toolkit, React Router, Axios, Jest, Testing Library, msw

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer (Frontend)
    subgraph "Presentation Layer" 
        direction TB
        Browser["React SPA"]:::frontend
        subgraph "UI Components"
            direction TB
            Dashboard["Dashboard"]:::frontend
            UploadFile["Upload File"]:::frontend
            TransactionsList["Transactions List"]:::frontend
            TransactionRow["Transaction Row"]:::frontend
            ReportView["Report View"]:::frontend
            MainLayout["Main Layout"]:::frontend
            ErrorBoundary["Error Boundary"]:::frontend
        end
        subgraph "Hooks & Utils"
            direction TB
            useFetch["useFetch Hook"]:::frontend
            formatUtils["format.ts"]:::frontend
            exportExcelUtils["exportExcel.ts"]:::frontend
        end
        subgraph "State Management"
            direction TB
            ReduxStore["Redux Store"]:::frontend
            TransactionsSlice["Transactions Slice"]:::frontend
        end
        subgraph "API Client"
            direction TB
            ApiClient["apiClient"]:::frontend
            AccountingService["accountingService"]:::frontend
        end
    end

    %% Application Layer (Backend)
    subgraph "Application Layer"
        direction TB
        AppEntry["ComptabiliteApplication"]:::backend
        subgraph "Controllers"
            direction TB
            AccountingController["AccountingController"]:::backend
        end
        subgraph "Services"
            direction TB
            AccountingServiceBE["AccountingService"]:::backend
            ReportService["ReportService"]:::backend
            ReportExportService["ReportExportService"]:::backend
        end
        subgraph "Repositories"
            direction TB
            LedgerRepo["GeneralLedgerEntryRepository"]:::backend
            ReportRepo["ReportRepository"]:::backend
        end
        subgraph "Config & Exception"
            direction TB
            JacksonConfig["JacksonConfig"]:::backend
            SwaggerConfig["SwaggerConfig"]:::backend
            ApplicationYML["application.yml"]:::backend
            ResourceNotFoundEx["ResourceNotFoundException"]:::backend
            TypeRapport["TypeRapport enum"]:::backend
        end
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        Database["Relational Database"]:::database
    end

    %% External
    SwaggerUI["Swagger UI"]:::external

    %% Flows
    Browser -->|interacts| Dashboard
    Dashboard -->|dispatch actions| ReduxStore
    UploadFile -->|dispatch actions| ReduxStore
    TransactionsList -->|dispatch actions| ReduxStore
    ReportView -->|dispatch actions| ReduxStore
    ReduxStore -->|calls| ApiClient
    ApiClient -->|requests| AccountingController
    AccountingController -->|invoke| AccountingServiceBE
    AccountingController -->|invoke| ReportService
    ReportingExportFlow["Report export"]:::external
    AccountingController -->|invoke| ReportExportService
    AccountingServiceBE -->|CRUD| LedgerRepo
    ReportService -->|CRUD| ReportRepo
    ReportExportService -->|uses POI| ReportingExportFlow
    AccountingServiceBE -->|persist| Database
    ReportService -->|persist| Database
    LedgerRepo -->|query| Database
    ReportRepo -->|query| Database
    SwaggerConfig -->|serves| SwaggerUI

    %% Click Events
    click Browser "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/App.tsx"
    click Dashboard "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/components/Dashboard.tsx"
    click UploadFile "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/components/UploadFile.tsx"
    click TransactionsList "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/components/TransactionsList.tsx"
    click TransactionRow "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/components/TransactionRow.tsx"
    click ReportView "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/components/Report.tsx"
    click MainLayout "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/components/Main.tsx"
    click ErrorBoundary "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/components/ErrorBoundary.tsx"
    click useFetch "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/hooks/useFetch.ts"
    click formatUtils "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/utils/format.ts"
    click exportExcelUtils "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/utils/exportExcel.ts"
    click ReduxStore "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/redux/store.ts"
    click TransactionsSlice "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/redux/slices/transactionsSlice.ts"
    click ApiClient "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/api/apiClient.ts"
    click AccountingService "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Front/src/api/accountingService.ts"
    click AppEntry "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Back/src/main/java/com/project/comptabilite/ComptabiliteApplication.java"
    click AccountingController "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Back/src/main/java/com/project/comptabilite/controller/AccountingController.kt"
    click AccountingServiceBE "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Back/src/main/java/com/project/comptabilite/service/AccountingService.kt"
    click ReportService "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Back/src/main/java/com/project/comptabilite/service/ReportService.kt"
    click ReportExportService "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Back/src/main/java/com/project/comptabilite/service/ReportExportService.kt"
    click LedgerRepo "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Back/src/main/java/com/project/comptabilite/repository/GeneralLedgerEntryRepository.kt"
    click ReportRepo "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Back/src/main/java/com/project/comptabilite/repository/ReportRepository.kt"
    click JacksonConfig "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Back/src/main/java/com/project/comptabilite/config/JacksonConfig.kt"
    click SwaggerConfig "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Back/src/main/java/com/project/comptabilite/config/SwaggerConfig.kt"
    click ApplicationYML "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Back/src/main/resources/application.yml"
    click ResourceNotFoundEx "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Back/src/main/java/com/project/comptabilite/exception/ResourceNotFoundException.kt"
    click TypeRapport "https://github.com/mohamedaminefairouk/comptasync/blob/master/ComptaSync-Back/src/main/java/com/project/comptabilite/util/TypeRapport.kt"

    %% Styles
    classDef frontend fill:#CDF0FF,stroke:#3399FF,color:#000;
    classDef backend fill:#D4F4DD,stroke:#33AA33,color:#000;
    classDef database fill:#FFE4B5,stroke:#FF9900,color:#000;
    classDef external fill:#E8E8E8,stroke:#AAAAAA,color:#000;
```
