# arman-mishra562/jobzure-backend architecture

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

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

## Overview

##### Project Type and Purpose
- JobZure Backend API: a standalone backend service (monolithic) written in TypeScript/Node.js with Express.
- Purpose: expose RESTful endpoints for user and admin workflows (authentication, two-factor, company listings, personal details) and persist data in PostgreSQL via Prisma ORM.

##### Key Architectural Components
- Client Layer (not in repo): frontend or third-party callers invoking HTTP endpoints over REST.
- API Layer (Express)
- src/index.ts: initializes Express server, middleware, routing prefix (/api/v1).
- src/routes/*.routes.ts: defines routes for admin, superAdmin, user.
- Controller Layer
- src/controllers/*.controller.ts: entry points for handling HTTP requests, invoking services, returning responses or errors.
- Service Layer
- src/services/*.ts: business logic (mail.service for email/2FA, rateLimit, user.cv generation).
- Schema & Validation
- src/schemas/*.schema.ts: Joi or Zod schemas for request payload validation.
- Data Access Layer (Prisma)
- prisma/schema.prisma: data model definitions.
- prisma/migrations: SQL scripts for versioned schema evolution.
- src/config/Db.ts: Prisma client setup and connection pooling.
- Auth & Security
- src/config/passport.ts: JWT strategy, two-factor auth flow.
- src/middlewares/middleware.ts: error handling, input sanitization, auth guard.
- Utilities
- src/utils/*.ts: shared helpers (asyncHandler, admin verification, user.mail2FA).
- External Services
- PostgreSQL database (hosted separately).
- Email provider (SMTP or transactional API).
- Infrastructure & Deployment
- Dockerfile: containerization.
- .env.example: environment variables (DB connection, JWT secrets, mail credentials).

##### Component Relationships and Data Flow
- Router delegates to Controller → Controller calls Service → Service uses Prisma client to read/write DB.
- Service may call External Service (email, 2FA SMS).
- Prisma client issues SQL to PostgreSQL.
- Responses propagate back up: DB → Service → Controller → Client.

##### Architectural Patterns & Principles
- Layered Architecture (Presentation → Controller → Service → Repository).
- Separation of Concerns (routing vs. business logic vs. data access).
- Single Responsibility (each controller/service focuses on one domain: user, admin, superAdmin).
- Token-based Authentication (JWT middleware).
- Two-Factor Authentication integration.
- Database migrations & seeding for consistency.

## Diagram (Mermaid)

```mermaid
flowchart TD
    classDef code fill:#D0E8FF,stroke:#005B96,color:#000;
    classDef external fill:#FFE5B4,stroke:#E67E22,color:#000;
    classDef database fill:#D5FFD0,stroke:#27AE60,color:#000;
    classDef infra fill:#F0F0F0,stroke:#AAA,color:#333;

    Client["Client (Frontend)"]:::external

    subgraph "API Layer"
        Router["Express Server\n(src/index.ts)"]:::code
        subgraph "Route Definitions"
            AdminRoute["Admin Routes"]:::code
            SuperAdminRoute["SuperAdmin Routes"]:::code
            UserRoute["User Routes"]:::code
        end
    end

    subgraph "Controller Layer"
        AdminController["Admin Controller"]:::code
        SuperAdminController["SuperAdmin Controller"]:::code
        UserController["User Controller"]:::code
        PersonalDetailsController["PersonalDetails Controller"]:::code
    end

    subgraph "Middleware & Validation"
        Middleware["Middlewares\n(rate limit, auth guard,\ninput validation)"]:::code
        subgraph "Schemas"
            AdminSchema["Admin Schema"]:::code
            UserSchema["User Schema"]:::code
        end
    end

    subgraph "Service Layer"
        MailService["Mail Service"]:::code
        RateLimitService["Rate Limit Service"]:::code
        UserCVService["User CV Service"]:::code
    end

    PrismaClient["Prisma Client\n(src/config/Db.ts)"]:::code
    PostgresDB["PostgreSQL Database"]:::database

    Migrations["Migration & Seed\n(prisma/migrations & prisma/seed.ts)"]:::infra
    EmailService["Email/SMS Service"]:::external

    subgraph "Infrastructure & Deployment"
        DockerfileNode["Dockerfile"]:::infra
        EnvExample[".env.example"]:::infra
        TSConfig["tsconfig.json"]:::infra
        PackageJSON["package.json"]:::infra
    end

    %% Connections
    Client -->|"HTTP request"| Router
    Router --> AdminRoute
    Router --> SuperAdminRoute
    Router --> UserRoute

    AdminRoute --> Middleware
    SuperAdminRoute --> Middleware
    UserRoute --> Middleware

    Middleware --> AdminController
    Middleware --> SuperAdminController
    Middleware --> UserController
    Middleware --> PersonalDetailsController

    AdminController --> MailService
    AdminController --> RateLimitService
    SuperAdminController --> MailService
    UserController --> UserCVService
    PersonalDetailsController --> RateLimitService

    MailService --> EmailService
    RateLimitService --> PrismaClient
    UserCVService --> PrismaClient

    PrismaClient -->|SQL queries| PostgresDB
    Migrations -->|offline updates| PostgresDB

    %% Click events
    click Router "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/index.ts"
    click AdminRoute "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/routes/admin.routes.ts"
    click SuperAdminRoute "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/routes/superAdmin.routes.ts"
    click UserRoute "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/routes/user.routes.ts"
    click AdminController "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/controllers/admin.controller.ts"
    click SuperAdminController "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/controllers/superAdmin.controller.ts"
    click UserController "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/controllers/user.controller.ts"
    click PersonalDetailsController "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/controllers/personalDetails.controller.ts"
    click MailService "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/services/mail.service.ts"
    click RateLimitService "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/services/rateLimit.ts"
    click UserCVService "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/services/user.cv.ts"
    click AdminSchema "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/schemas/admin.schema.ts"
    click UserSchema "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/schemas/user.schema.ts"
    click PrismaClient "https://github.com/arman-mishra562/jobzure-backend/blob/main/src/config/Db.ts"
    click Migrations "https://github.com/arman-mishra562/jobzure-backend/tree/main/prisma/migrations"
    click Migrations "https://github.com/arman-mishra562/jobzure-backend/blob/main/prisma/seed.ts"
    click DockerfileNode "https://github.com/arman-mishra562/jobzure-backend/tree/main/Dockerfile"
    click EnvExample "https://github.com/arman-mishra562/jobzure-backend/blob/main/.env.example"
    click TSConfig "https://github.com/arman-mishra562/jobzure-backend/blob/main/tsconfig.json"
    click PackageJSON "https://github.com/arman-mishra562/jobzure-backend/blob/main/package.json"
```
