# arman-mishra562/internvault-backend architecture

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

- Interactive diagram: https://gitdiagram.com/arman-mishra562/internvault-backend
- Repository: https://github.com/arman-mishra562/internvault-backend

## Overview

##### Project Type and Purpose
- This is a standalone backend service (Node.js + Express) providing RESTful endpoints for Authentication, Application Management, Payment Processing, and Dynamic Pricing.
- It uses Prisma ORM to interact with a PostgreSQL database and integrates with SMTP (email), Stripe, PayPal, Google OAuth, and an IP geolocation API.

##### File Structure
- Entry point: src/app.ts
- Layered folders under src/:
- config/ (configuration of third-party clients: Prisma, Stripe, PayPal, Google, Mailer)
- middlewares/ (authentication, request validation)
- routes/ route definitions mapping URL paths to controllers
- controllers/ business-logic handlers for each feature domain
- schemas/ Zod validation schemas
- utils/ shared helper functions (token generation, email templates, geolocation)
- Prisma folder with schema and migrations for User, Application, Payment, PricingPlan models.

##### Pull Additional Insights from README
- JWT-based auth with email verification and Google OAuth
- Application lifecycle (statuses, payment tie-in)
- Atomic payments via Stripe/PayPal with webhooks
- Geo-based, currency-aware dynamic pricing
- Env variables define external endpoints, secrets, and DB connection.

##### Main Components and Their Interactions
A. Client (Web/Mobile Frontend)
- Sends HTTP requests (`/api/auth`, `/api/applications`, `/api/pricing`, etc.).
B. API Gateway (Express App)
- app.ts initializes Express, loads global middlewares (CORS, JSON parser).
- Mounts route groups under `/api` and `/webhook`.
C. Middleware Layer
- Authentication (JWT validation, `auth.middleware`)
- Request validation (Zod schemas via `validateRequest`)
D. Controller Layer
- `auth.controller` (register, login, verify email, password reset)
- `application.controller` (submit, list, status updates)
- `payment.controller` (initiate Stripe/PayPal payments)
- `pricing.controller` (CRUD pricing plans, carousel)
E. Service / Utils Layer
- Prisma client (DB access via `config/prisma.ts`)
- Email (Nodemailer via `config/mailer.ts` + `utils/emailTemplates`)
- Payment SDKs (Stripe, PayPal via `config/stripe.ts` & `config/paypal.ts`)
- Token generators and geolocation helpers in utils/
F. Database
- PostgreSQL (User, Application, Payment, PricingPlan)
G. External Services
- SMTP server (Gmail)
- Stripe & Google Pay via Stripe SDK
- PayPal REST API
- Google OAuth API
- IP geolocation API (ip-api.com)
- Webhook endpoints for asynchronous payment events

##### Architectural Patterns & Design Principles
- Layered Architecture (Routing → Middleware → Controllers → Data Access)
- Single-Responsibility Modules (each folder handles a distinct concern)
- Event-driven integration for payment webhooks
- Validation as a cross-cutting concern (Zod schemas + middleware)
- Configuration isolation (config/ folder for externals)
- ORM via Prisma (repository pattern)

- Clear component names (e.g., “auth.controller”, “Prisma Client”)
- Core backend layers
- Database
- External integrations
- Client boundary
- Optional: Deployment boundary (Docker container hosting the Express service, connected to a managed Postgres instance).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client
    Client["Web/Mobile Client"]:::client

    %% Express API Gateway
    subgraph "Express API Gateway"
        App["app.ts (Express Initialization)"]:::internal
        subgraph "Routes Layer"
            AuthRoute["auth.route.ts"]:::routes
            AppRoute["application.route.ts"]:::routes
            PricingRoute["pricing.route.ts"]:::routes
        end
        subgraph "Middleware Layer"
            AuthMiddleware["auth.middleware.ts"]:::middleware
            ValidateMiddleware["validateRequest.ts"]:::middleware
        end
        subgraph "Controller Layer"
            AuthController["auth.controller.ts"]:::controller
            ApplicationController["application.controller.ts"]:::controller
            PaymentController["payment.controller.ts"]:::controller
            PricingController["pricing.controller.ts"]:::controller
        end
    end

    %% Service / Utils Layer
    subgraph "Service & Utils Layer"
        subgraph "Configuration"
            PrismaConfig["prisma.ts"]:::config
            StripeConfig["stripe.ts"]:::config
            PayPalConfig["paypal.ts"]:::config
            GoogleConfig["google.ts"]:::config
            MailerConfig["mailer.ts"]:::config
        end
        subgraph "Utilities"
            EmailTemplates["emailTemplates.ts"]:::util
            TokenHelpers["Token Generation Helpers"]:::util
            Geolocation["geolocation.ts"]:::util
        end
        subgraph "Validation Schemas"
            AuthSchema["auth.schema.ts"]:::util
            PasswordSchema["password.schema.ts"]:::util
            ApplicationSchema["application.schema.ts"]:::util
            PricingSchema["pricing.schema.ts"]:::util
        end
    end

    %% Database
    subgraph "Database"
        PrismaClient["Prisma Client"]:::internal
        Postgres["PostgreSQL"]:::database
    end

    %% External Services
    subgraph "External Integrations"
        SMTP["SMTP Server (Gmail)"]:::external
        StripeAPI["Stripe API"]:::external
        PayPalAPI["PayPal REST API"]:::external
        GoogleOAuth["Google OAuth API"]:::external
        IPGeo["IP Geolocation API"]:::external
        Webhooks["Payment Webhooks"]:::external
    end

    %% Client to API
    Client -->|"HTTP REST"| AuthRoute
    Client -->|"HTTP REST"| AppRoute
    Client -->|"HTTP REST"| PricingRoute

    %% Routes to Middleware to Controllers
    AuthRoute -->|"/api/auth"| AuthMiddleware -->|"validates JWT / requests"| AuthController
    AppRoute -->|"/api/applications"| AuthMiddleware --> ApplicationController
    AppRoute -->|"/api/applications"| ValidateMiddleware --> ApplicationController
    PricingRoute -->|"/api/pricing"| ValidateMiddleware --> PricingController

    %% Controllers to Services
    AuthController -->|"DB Queries"| PrismaClient
    AuthController -->|"Send Email"| EmailTemplates
    AuthController -->|"Generate Tokens"| TokenHelpers

    ApplicationController -->|"DB Queries"| PrismaClient
    ApplicationController -->|"Initiate Payment"| StripeConfig
    ApplicationController -->|"Initiate Payment"| PayPalConfig

    PaymentController -->|"Call Stripe SDK"| StripeConfig
    PaymentController -->|"Call PayPal SDK"| PayPalConfig

    PricingController -->|"DB Queries"| PrismaClient
    PricingController -->|"Geo Pricing"| Geolocation

    %% Service to External
    PrismaClient -->|"SQL"| Postgres
    EmailTemplates -->|"SMTP"| SMTP
    StripeConfig -->|"HTTPS REST"| StripeAPI
    PayPalConfig -->|"HTTPS REST"| PayPalAPI
    GoogleConfig -->|"OAuth Flow"| GoogleOAuth
    Geolocation -->|"HTTP API"| IPGeo

    %% Webhooks
    StripeAPI -->|"Webhook JSON"| Webhooks -->|"/webhook/payment"| PaymentController
    PayPalAPI -->|"Webhook JSON"| Webhooks -->|"/webhook/payment"| PaymentController

    %% Click Events
    click App "https://github.com/arman-mishra562/internvault-backend/blob/main/src/app.ts"
    click PrismaConfig "https://github.com/arman-mishra562/internvault-backend/blob/main/src/config/prisma.ts"
    click StripeConfig "https://github.com/arman-mishra562/internvault-backend/blob/main/src/config/stripe.ts"
    click PayPalConfig "https://github.com/arman-mishra562/internvault-backend/blob/main/src/config/paypal.ts"
    click GoogleConfig "https://github.com/arman-mishra562/internvault-backend/blob/main/src/config/google.ts"
    click MailerConfig "https://github.com/arman-mishra562/internvault-backend/blob/main/src/config/mailer.ts"
    click AuthMiddleware "https://github.com/arman-mishra562/internvault-backend/blob/main/src/middlewares/auth.middleware.ts"
    click ValidateMiddleware "https://github.com/arman-mishra562/internvault-backend/blob/main/src/middlewares/validateRequest.ts"
    click AuthRoute "https://github.com/arman-mishra562/internvault-backend/blob/main/src/routes/auth.route.ts"
    click AppRoute "https://github.com/arman-mishra562/internvault-backend/blob/main/src/routes/application.route.ts"
    click PricingRoute "https://github.com/arman-mishra562/internvault-backend/blob/main/src/routes/pricing.route.ts"
    click AuthController "https://github.com/arman-mishra562/internvault-backend/blob/main/src/controllers/auth.controller.ts"
    click ApplicationController "https://github.com/arman-mishra562/internvault-backend/blob/main/src/controllers/application.controller.ts"
    click PaymentController "https://github.com/arman-mishra562/internvault-backend/blob/main/src/controllers/payment.controller.ts"
    click PricingController "https://github.com/arman-mishra562/internvault-backend/blob/main/src/controllers/pricing.controller.ts"
    click AuthSchema "https://github.com/arman-mishra562/internvault-backend/blob/main/src/schemas/auth.schema.ts"
    click PasswordSchema "https://github.com/arman-mishra562/internvault-backend/blob/main/src/schemas/password.schema.ts"
    click ApplicationSchema "https://github.com/arman-mishra562/internvault-backend/blob/main/src/schemas/application.schema.ts"
    click PricingSchema "https://github.com/arman-mishra562/internvault-backend/blob/main/src/schemas/pricing.schema.ts"
    click EmailTemplates "https://github.com/arman-mishra562/internvault-backend/blob/main/src/utils/emailTemplates.ts"
    click Geolocation "https://github.com/arman-mishra562/internvault-backend/blob/main/src/utils/geolocation.ts"
    click TokenHelpers "https://github.com/arman-mishra562/internvault-backend/blob/main/src/utils/token.ts"
    click TokenHelpers "https://github.com/arman-mishra562/internvault-backend/blob/main/src/utils/generateResetToken.ts"
    click TokenHelpers "https://github.com/arman-mishra562/internvault-backend/blob/main/src/utils/generateVerificationToken.ts"
    click TokenHelpers "https://github.com/arman-mishra562/internvault-backend/blob/main/src/utils/generateUserId.ts"

    %% Styles
    classDef client fill:#FFA500,stroke:#333,stroke-width:1px;
    classDef internal fill:#D0E6FF,stroke:#333,stroke-width:1px;
    classDef routes fill:#B3D1FF,stroke:#333,stroke-width:1px;
    classDef middleware fill:#FFECB3,stroke:#333,stroke-width:1px;
    classDef controller fill:#FFCC80,stroke:#333,stroke-width:1px;
    classDef config fill:#C8E6C9,stroke:#333,stroke-width:1px;
    classDef util fill:#E1BEE7,stroke:#333,stroke-width:1px;
    classDef database fill:#A5D6A7,stroke:#333,stroke-width:1px;
    classDef external fill:#EEEEEE,stroke:#333,stroke-width:1px;
```
