# ibalpinar/resumex architecture

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

- Interactive diagram: https://gitdiagram.com/ibalpinar/resumex
- Repository: https://github.com/ibalpinar/resumex

## Overview

##### Project type and purpose
- ResumeX is a Node.js-based REST API backend for an open-source resume platform. It exposes versioned endpoints (v1) for user/account management, authentication, resume CRUD, and lookups (countries, languages, skills, etc.). Data is persisted in MongoDB.

##### File structure
- Top-level: configuration files (`config/dev.env`), linter/formatter rules, `package.json`.
- `src/index.js`: entry-point.
- `src/routes/v1`: Express routers & JSON schema validators (OpenAPI-style).
- `src/decorators`: middleware wrappers for authentication & account checks.
- `src/handlers`: controllers implementing each REST operation.
- `src/models`: Mongoose schemas/entities.
- `src/utils`: cross-cutting utilities (errors, constants, password manager, initial data loader, response helpers).
- `misc/postman-collection`: sample API collection for testing.

a. Client layer
- REST client (frontend app or tool like Postman).
b. API Gateway / HTTP Server
- Express.js instance (`index.js`)
- Global middleware (logging, JSON parser).
c. Routing Layer
- Versioned routers (`common.js`, `v1/*.js`)
- JSON-schema validation per-route.
d. Decorator/Middleware Layer
- AuthenticationDecorator (JWT/session check)
- AccountDecorator (role/permission checks)
e. Controller Layer
- `accountController`, `authenticationController`, `userController`, `resumeController`, `lookupController`
f. Service & Utility Layer
- Business logic in controller or delegated to `utils` (e.g., `passwordManager`, `responseHelpers`, `insertInitialData`).
g. Data Access Layer
- Mongoose models (`models/*.js`) mapping to MongoDB collections.
h. Database
- MongoDB (hosted locally or cloud)
i. External Services (future/optional)
- Email/SMS provider for password reset, analytics, or storage service for resume assets.

##### Relationships & data flow
Client → HTTP Server → Router → [Validation] → Decorators → Controller → Data Access → MongoDB
Controller → Utility modules → (optionally) External Services

##### Architectural patterns & design principles
- Layered (Presentation → Routing → Middleware/Decorators → Controllers → Models)
- Separation of concerns: validation, auth, business logic, data persistence
- Versioning: routes separated by API version.
- OpenAPI-style contract: JSON schemas for request/response.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Client
    Client["REST Client\n(Postman, Frontend)"]:::external

    %% HTTP Server Layer
    HTTP["Express Server\n(src/index.js)\nHTTP/JSON, port 3000"]:::http

    %% Routing Layer
    CommonRouter["Common Router\n(src/routes/common.js)"]:::routing

    subgraph "v1 Routing"
        direction TB
        AccountRoutes["Account Routes v1\n(src/routes/v1/accountRoutes.js)"]:::routing
        AuthenticationRoutes["Authentication Routes v1\n(src/routes/v1/authenticationRoutes.js)"]:::routing
        UserRoutes["User Routes v1\n(src/routes/v1/userRoutes.js)"]:::routing
        ResumeRoutes["Resume Routes v1\n(src/routes/v1/resumeRoutes.js)"]:::routing
        LookupRoutes["Lookup Routes v1\n(src/routes/v1/lookupRoutes.js)"]:::routing

        AccountSchema["Account Schema\n(src/routes/v1/schemas/accountServiceSchema.js)"]:::schema
        AuthenticationSchema["Authentication Schema\n(src/routes/v1/schemas/authenticationServiceSchema.js)"]:::schema
        UserSchema["User Schema\n(src/routes/v1/schemas/userServiceSchema.js)"]:::schema
        ResumeSchema["Resume Schema\n(src/routes/v1/schemas/resumeServiceSchema.js)"]:::schema
        LookupSchema["Lookup Schema\n(src/routes/v1/schemas/lookupServiceSchema.js)"]:::schema
    end

    %% Decorator/Middleware Layer
    subgraph "Decorators"
        direction TB
        AuthDecorator["Authentication Decorator\n(src/decorators/authenticationDecorator.js)"]:::middleware
        AccountDecorator["Account Decorator\n(src/decorators/accountDecorator.js)"]:::middleware
    end

    %% Controller Layer
    subgraph "Controllers"
        direction TB
        AccountController["Account Controller\n(src/handlers/accountController.js)"]:::controller
        AuthenticationController["Authentication Controller\n(src/handlers/authenticationController.js)"]:::controller
        UserController["User Controller\n(src/handlers/userController.js)"]:::controller
        ResumeController["Resume Controller\n(src/handlers/resumeController.js)"]:::controller
        LookupController["Lookup Controller\n(src/handlers/lookupController.js)"]:::controller
    end

    %% Service & Utility Layer
    subgraph "Utilities"
        direction TB
        PasswordManager["Password Manager\n(src/utils/passwordManager.js)"]:::service
        ResponseHelpers["Response Helpers\n(src/utils/responseHelpers.js)"]:::service
        InitialDataLoader["Initial Data Loader\n(src/utils/insertInitialData.js)"]:::service
        Constants["Constants\n(src/utils/constants.js)"]:::service
        Errors["Error Definitions\n(src/utils/errors.js)"]:::service
    end

    %% Data Access Layer (Models)
    subgraph "Models"
        direction TB
        UserModel["User Model\n(src/models/User.js)"]:::db
        ResumeModel["Resume Model\n(src/models/Resume.js)"]:::db
        CountryModel["Country Model\n(src/models/Country.js)"]:::db
        ContinentModel["Continent Model\n(src/models/Continent.js)"]:::db
        LanguageModel["Language Model\n(src/models/Language.js)"]:::db
        SkillModel["Skill Model\n(src/models/Skill.js)"]:::db
        InterestModel["Interest Model\n(src/models/Interest.js)"]:::db
        ResumeThemeModel["ResumeTheme Model\n(src/models/ResumeTheme.js)"]:::db
        UserTypeModel["UserType Model\n(src/models/UserType.js)"]:::db
        UserConfirmationModel["UserConfirmation Model\n(src/models/UserConfirmation.js)"]:::db
        ForgotPasswordModel["ForgotPasswordRequest Model\n(src/models/ForgotPasswordRequest.js)"]:::db
    end

    %% Database
    MongoDB["MongoDB\n(collections)"]:::database

    %% Connections
    Client -->|HTTP/JSON| HTTP
    HTTP --> CommonRouter
    CommonRouter --> AccountRoutes
    CommonRouter --> AuthenticationRoutes
    CommonRouter --> UserRoutes
    CommonRouter --> ResumeRoutes
    CommonRouter --> LookupRoutes

    AccountRoutes -->|validates| AccountSchema --> AuthDecorator --> AccountDecorator --> AccountController
    AuthenticationRoutes -->|validates| AuthenticationSchema --> AuthDecorator --> AuthenticationController
    UserRoutes -->|validates| UserSchema --> AuthDecorator --> UserController
    ResumeRoutes -->|validates| ResumeSchema --> AuthDecorator --> ResumeController
    LookupRoutes -->|validates| LookupSchema --> AuthDecorator --> LookupController

    AccountController --> UserModel
    AccountController --> UserConfirmationModel
    AccountController --> ForgotPasswordModel

    AuthenticationController --> UserModel
    AuthenticationController --> ForgotPasswordModel

    UserController --> UserModel
    ResumeController --> ResumeModel
    ResumeController --> ResumeThemeModel
    LookupController --> CountryModel
    LookupController --> ContinentModel
    LookupController --> LanguageModel
    LookupController --> SkillModel
    LookupController --> InterestModel
    LookupController --> UserTypeModel

    AccountController --> PasswordManager
    AuthenticationController --> PasswordManager
    UserController --> ResponseHelpers
    ResumeController --> ResponseHelpers
    LookupController --> ResponseHelpers
    InitialDataLoader --> MongoDB

    UserModel --> MongoDB
    ResumeModel --> MongoDB
    CountryModel --> MongoDB
    ContinentModel --> MongoDB
    LanguageModel --> MongoDB
    SkillModel --> MongoDB
    InterestModel --> MongoDB
    ResumeThemeModel --> MongoDB
    UserTypeModel --> MongoDB
    UserConfirmationModel --> MongoDB
    ForgotPasswordModel --> MongoDB

    %% Click Events
    click HTTP "https://github.com/ibalpinar/resumex/blob/dev/src/index.js"
    click CommonRouter "https://github.com/ibalpinar/resumex/blob/dev/src/routes/common.js"
    click AccountRoutes "https://github.com/ibalpinar/resumex/blob/dev/src/routes/v1/accountRoutes.js"
    click AuthenticationRoutes "https://github.com/ibalpinar/resumex/blob/dev/src/routes/v1/authenticationRoutes.js"
    click UserRoutes "https://github.com/ibalpinar/resumex/blob/dev/src/routes/v1/userRoutes.js"
    click ResumeRoutes "https://github.com/ibalpinar/resumex/blob/dev/src/routes/v1/resumeRoutes.js"
    click LookupRoutes "https://github.com/ibalpinar/resumex/blob/dev/src/routes/v1/lookupRoutes.js"
    click AccountSchema "https://github.com/ibalpinar/resumex/blob/dev/src/routes/v1/schemas/accountServiceSchema.js"
    click AuthenticationSchema "https://github.com/ibalpinar/resumex/blob/dev/src/routes/v1/schemas/authenticationServiceSchema.js"
    click UserSchema "https://github.com/ibalpinar/resumex/blob/dev/src/routes/v1/schemas/userServiceSchema.js"
    click ResumeSchema "https://github.com/ibalpinar/resumex/blob/dev/src/routes/v1/schemas/resumeServiceSchema.js"
    click LookupSchema "https://github.com/ibalpinar/resumex/blob/dev/src/routes/v1/schemas/lookupServiceSchema.js"
    click AuthDecorator "https://github.com/ibalpinar/resumex/blob/dev/src/decorators/authenticationDecorator.js"
    click AccountDecorator "https://github.com/ibalpinar/resumex/blob/dev/src/decorators/accountDecorator.js"
    click AccountController "https://github.com/ibalpinar/resumex/blob/dev/src/handlers/accountController.js"
    click AuthenticationController "https://github.com/ibalpinar/resumex/blob/dev/src/handlers/authenticationController.js"
    click UserController "https://github.com/ibalpinar/resumex/blob/dev/src/handlers/userController.js"
    click ResumeController "https://github.com/ibalpinar/resumex/blob/dev/src/handlers/resumeController.js"
    click LookupController "https://github.com/ibalpinar/resumex/blob/dev/src/handlers/lookupController.js"
    click PasswordManager "https://github.com/ibalpinar/resumex/blob/dev/src/utils/passwordManager.js"
    click ResponseHelpers "https://github.com/ibalpinar/resumex/blob/dev/src/utils/responseHelpers.js"
    click InitialDataLoader "https://github.com/ibalpinar/resumex/blob/dev/src/utils/insertInitialData.js"
    click Constants "https://github.com/ibalpinar/resumex/blob/dev/src/utils/constants.js"
    click Errors "https://github.com/ibalpinar/resumex/blob/dev/src/utils/errors.js"
    click UserModel "https://github.com/ibalpinar/resumex/blob/dev/src/models/User.js"
    click ResumeModel "https://github.com/ibalpinar/resumex/blob/dev/src/models/Resume.js"
    click CountryModel "https://github.com/ibalpinar/resumex/blob/dev/src/models/Country.js"
    click ContinentModel "https://github.com/ibalpinar/resumex/blob/dev/src/models/Continent.js"
    click LanguageModel "https://github.com/ibalpinar/resumex/blob/dev/src/models/Language.js"
    click SkillModel "https://github.com/ibalpinar/resumex/blob/dev/src/models/Skill.js"
    click InterestModel "https://github.com/ibalpinar/resumex/blob/dev/src/models/Interest.js"
    click ResumeThemeModel "https://github.com/ibalpinar/resumex/blob/dev/src/models/ResumeTheme.js"
    click UserTypeModel "https://github.com/ibalpinar/resumex/blob/dev/src/models/UserType.js"
    click UserConfirmationModel "https://github.com/ibalpinar/resumex/blob/dev/src/models/UserConfirmation.js"
    click ForgotPasswordModel "https://github.com/ibalpinar/resumex/blob/dev/src/models/ForgotPasswordRequest.js"

    %% Styles
    classDef http fill:#B3CDE3,stroke:#333,stroke-width:1px
    classDef routing fill:#6497B1,stroke:#333,stroke-width:1px
    classDef schema fill:#005B96,stroke:#fff,stroke-width:1px,color:#fff
    classDef middleware fill:#C7E9C0,stroke:#333,stroke-width:1px
    classDef controller fill:#B2DF8A,stroke:#333,stroke-width:1px
    classDef service fill:#33A02C,stroke:#fff,stroke-width:1px,color:#fff
    classDef db fill:#FDBF6F,stroke:#333,stroke-width:1px
    classDef database fill:#FF7F00,stroke:#333,stroke-width:1px
    classDef external fill:#CAB2D6,stroke:#333,stroke-width:1px
```
