# klebermera/finzenapirest architecture

> Architecture diagram of the GitHub repository klebermera/finzenapirest, 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/klebermera/finzenapirest
- Repository: https://github.com/klebermera/finzenapirest

## Overview

##### Project type and purpose
- This is a NestJS-based, serverless, Node.js backend API for a personal finance/transaction management system.
- It exposes HTTP endpoints (via AWS API Gateway → Lambda), persists data in a relational database (via Prisma), stores images via S3, and integrates with external services (Generative AI, Firebase/Auth, FCM/Web-Push, email).

##### File structure
- Top level:
- serverless.yml → defines AWS infra (API Gateway, Lambda functions, S3 buckets, RDS, scheduled jobs)
- prisma/ → database schema & migrations
- src/config → configuration modules for Prisma, S3, Generative AI, service accounts
- src/modules → 20+ feature modules (auth, user, transaction, recurrent-transaction, debt, balance, goal, finance, notifications, etc.)
- src/providers → mail & web-push providers
- src/guards → request-guard (token auth)
- lambda.ts & main.ts → Lambda handler entrypoint & standard NestJS bootstrap

##### README
- Generic NestJS starter README with instructions for running, testing, and deploying via Mau or generic cloud.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "AWS Infrastructure" 
        style AWSInfra fill:#cce5ff,stroke:#1f77b4
        APIGW["API Gateway"]:::infra
        SLS["serverless.yml"]:::infra
        APIGW -->|HTTP| LAMBDA
    end

    subgraph "Lambda: NestJS Monolith" 
        style LambdaInfra fill:#cce5ff,stroke:#1f77b4
        LAMBDA["Lambda (NestJS)"]:::infra
        click LAMBDA "https://github.com/klebermera/finzenapirest/blob/main/src/lambda.ts"
        MAIN["Local Bootstrap (main.ts)"]:::infra
        click MAIN "https://github.com/klebermera/finzenapirest/blob/main/src/main.ts"

        subgraph "Configuration Modules"
            PRISMA_MOD["Prisma Module"]:::app
            click PRISMA_MOD "https://github.com/klebermera/finzenapirest/blob/main/src/config/prisma/prisma.module.ts"
            PRISMA_SVC["Prisma Service"]:::app
            click PRISMA_SVC "https://github.com/klebermera/finzenapirest/blob/main/src/config/prisma/prisma.service.ts"
            S3_MOD["S3 Module"]:::app
            click S3_MOD "https://github.com/klebermera/finzenapirest/blob/main/src/config/s3/s3.module.ts"
            S3_SVC["S3 Service"]:::app
            click S3_SVC "https://github.com/klebermera/finzenapirest/blob/main/src/config/s3/s3.service.ts"
            AI_SVC["Generative AI Service"]:::app
            click AI_SVC "https://github.com/klebermera/finzenapirest/blob/main/src/config/generative-ai/generative-ai.service.ts"
            SA["Service Accounts"]:::app
            click SA "https://github.com/klebermera/finzenapirest/blob/main/src/config/services-account.ts"
        end

        subgraph "Feature Modules"
            AuthMod["Auth Module"]:::app
            click AuthMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/auth/auth.module.ts"
            UserMod["User Module"]:::app
            click UserMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/user/user.module.ts"
            TransactionMod["Transaction Module"]:::app
            click TransactionMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/transaction/transaction.module.ts"
            RecTransactionMod["Recurrent-Transaction Module"]:::app
            click RecTransactionMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/recurrent-transaction/recurrent-transaction.module.ts"
            BalanceMod["Balance Module"]:::app
            click BalanceMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/balance/balance.module.ts"
            DebtMod["Debt Module"]:::app
            click DebtMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/debt/debt.module.ts"
            GoalMod["Goal Module"]:::app
            click GoalMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/goal/goal.module.ts"
            FinanceMod["Finance Module"]:::app
            click FinanceMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/finance/finance.module.ts"
            TicketsMod["Tickets Module"]:::app
            click TicketsMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/tickets/tickets.module.ts"
            NotificationsMod["Notifications Module"]:::app
            click NotificationsMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/notifications/notifications.module.ts"
            FCMMod["FCM Notification Module"]:::app
            click FCMMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/fcm-notification/fcm-notification.module.ts"
            SendNotifMod["Send-Notification Module"]:::app
            click SendNotifMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/send-notification/send-notification.module.ts"
            FirebaseMod["Firebase Module"]:::app
            click FirebaseMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/firebase/firebase.module.ts"
            AdminGraficMod["Admin Grafic Module"]:::app
            click AdminGraficMod "https://github.com/klebermera/finzenapirest/blob/main/src/modules/admin/grafic-admin/grafic-admin.module.ts"
        end

        LAMBDA -->|uses| PRISMA_MOD
        PRISMA_MOD -->|queries| DB
        LAMBDA -->|uploads/downloads| S3_MOD
    end

    subgraph "Database & Storage" 
        DB["RDS (PostgreSQL)"]:::infra
        SCHEMA["prisma/schema.prisma"]:::infra
        click SCHEMA "https://github.com/klebermera/finzenapirest/blob/main/prisma/schema.prisma"
        MIG["prisma/migrations"]:::infra
        click MIG "https://github.com/klebermera/finzenapirest/tree/main/prisma/migrations"
        S3["S3 Bucket"]:::infra
    end

    subgraph "External Services" 
        AI["Generative AI API"]:::ext
        FBAuth["Firebase Auth"]:::ext
        FCM["Firebase Cloud Messaging"]:::ext
        WP["Web-Push Service"]:::ext
        MAIL["Mail Provider"]:::ext
    end

    AI_SVC -->|REST| AI
    FirebaseMod -->|SDK| FBAuth
    NotificationsMod -->|SDK| FCM
    NotificationsMod -->|Web-Push| WP
    NotificationsMod -->|SMTP/SES| MAIL

    CRON["Scheduled Cron Event"]:::infra
    CRON -->|trigger send-notification| LAMBDA

    classDef infra fill:#cce5ff,stroke:#1f77b4
    classDef app fill:#d4edda,stroke:#2ca02c
    classDef ext fill:#ffe5b4,stroke:#ff7f0e
```
