# suraj4127/pixelforge-dynamic-images architecture

> Architecture diagram of the GitHub repository suraj4127/pixelforge-dynamic-images, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/suraj4127/pixelforge-dynamic-images
- Repository: https://github.com/suraj4127/pixelforge-dynamic-images

## Overview

Webengage Creative Studio lets internal users create layered image templates and render personalized PNGs through a public URL; accounts require email/password and verified mobile numbers. The main workflow is sign in or register, manage a template, then request a render with personalization values. Rendering retrieves template data and background imagery, composites text/image layers, and returns a PNG, with Redis and in-memory caches supporting repeated work. The graph reflects documented capabilities and sampled relationships; unsampled subsystems are included only where the README or source index establishes them.

Main entry points: [`src/routes/auth.routes.js`](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/routes/auth.routes.js) (Account endpoints), [`src/routes/template.routes.js`](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/routes/template.routes.js) (Template endpoints), [`src/routes/render.routes.js`](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/routes/render.routes.js) (PNG render endpoint), [`src/app.js`](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/app.js) (HTTP app)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Application entry"]
  node_browser["Studio UI"]
  node_server["Server process<br/>[server.js]"]
  node_app["HTTP app<br/>[app.js]"]
end

subgraph group_accounts["Accounts and access"]
  node_auth["Account endpoints<br/>[auth.routes.js]"]
  node_guards["Access guards<br/>[guards.js]"]
  node_sessions["Session handling<br/>[sessions.js]"]
  node_passwords["Password hashing<br/>[passwords.js]"]
  node_otp["Phone verification<br/>[otp.js]"]
  node_users["User records<br/>[userRepository.js]"]
end

subgraph group_studio["Template studio"]
  node_templates["Template endpoints<br/>[template.routes.js]"]
  node_template_data["Template records"]
  node_pages["Page routes<br/>[page.routes.js]"]
end

subgraph group_rendering["Personalized rendering"]
  node_renderer["PNG render endpoint<br/>[render.routes.js]"]
  node_image_loader["Image loading<br/>[images.js]"]
  node_cache["Memory caches<br/>[cache.js]"]
end

subgraph group_platform["Storage and integrations"]
  node_metrics["Render metrics<br/>[metrics.js]"]
  node_schema["Schema setup<br/>[schema.js]"]
  node_mysql[("MySQL<br/>[db.js]")]
  node_redis[("Redis<br/>[redis.js]")]
  node_s3[("S3 object storage<br/>[s3.js]")]
  node_webengage["WebEngage SMS<br/>[webengage.js]"]
end

node_user(("Studio user"))

node_user -->|"uses"| node_browser
node_browser -.->|"requests pages and APIs"| node_app
node_server -->|"starts"| node_app
node_app -->|"mounts routes"| node_auth
node_app -->|"mounts routes"| node_templates
node_app -->|"mounts routes"| node_renderer
node_app -->|"mounts routes"| node_pages
node_auth -->|"reads and writes"| node_users
node_auth -->|"hashes and verifies"| node_passwords
node_auth -->|"sets and clears sessions"| node_sessions
node_auth -->|"issues and verifies codes"| node_otp
node_auth -->|"sends verification SMS"| node_webengage
node_auth -->|"checks admin access"| node_guards
node_guards -->|"loads current role"| node_users
node_guards -->|"ensures account schema"| node_schema
node_sessions -.->|"resolves session user"| node_users
node_templates -->|"protects studio routes"| node_guards
node_templates -->|"reads and writes"| node_template_data
node_templates -->|"loads upload background"| node_image_loader
node_templates -->|"uploads background"| node_s3
node_templates -->|"caches and invalidates templates"| node_redis
node_templates -->|"clears image caches"| node_cache
node_template_data -->|"queries template rows"| node_mysql
node_renderer -->|"loads template"| node_template_data
node_renderer -->|"ensures template schema"| node_schema
node_renderer -->|"reads and caches renders"| node_redis
node_renderer -->|"loads background and overlays"| node_image_loader
node_renderer -->|"uses image caches"| node_cache
node_renderer -->|"records render metrics"| node_metrics
node_image_loader -->|"uses shared cache"| node_redis
node_image_loader -->|"uses local caches"| node_cache
node_schema -->|"creates and updates tables"| node_mysql
node_otp -->|"stores verification codes"| node_redis
node_pages -->|"gates pages"| node_guards

click node_browser "https://github.com/suraj4127/pixelforge-dynamic-images/tree/main/public"
click node_server "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/server.js"
click node_app "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/app.js"
click node_auth "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/routes/auth.routes.js"
click node_guards "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/middleware/guards.js"
click node_sessions "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/services/sessions.js"
click node_passwords "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/services/passwords.js"
click node_otp "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/services/otp.js"
click node_users "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/repositories/userRepository.js"
click node_templates "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/routes/template.routes.js"
click node_template_data "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/repositories/templateRepository.js"
click node_pages "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/routes/page.routes.js"
click node_renderer "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/routes/render.routes.js"
click node_image_loader "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/services/images.js"
click node_cache "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/lib/cache.js"
click node_metrics "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/lib/metrics.js"
click node_schema "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/db/schema.js"
click node_mysql "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/config/db.js"
click node_redis "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/config/redis.js"
click node_s3 "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/config/s3.js"
click node_webengage "https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/services/webengage.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_browser,node_server,node_app,node_user toneBlue
class node_auth,node_guards,node_sessions,node_passwords,node_otp,node_users toneAmber
class node_templates,node_template_data,node_pages toneMint
class node_renderer,node_image_loader,node_cache toneRose
class node_metrics,node_schema,node_mysql,node_redis,node_s3,node_webengage toneIndigo
```

## Components

### Application entry

- [Studio UI](https://github.com/suraj4127/pixelforge-dynamic-images/tree/main/public): `public`
- [Server process](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/server.js): `src/server.js`
- [HTTP app](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/app.js): `src/app.js`

### Accounts and access

- [Account endpoints](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/routes/auth.routes.js): `src/routes/auth.routes.js`
- [Access guards](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/middleware/guards.js): `src/middleware/guards.js`
- [Session handling](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/services/sessions.js): `src/services/sessions.js`
- [Password hashing](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/services/passwords.js): `src/services/passwords.js`
- [Phone verification](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/services/otp.js): `src/services/otp.js`
- [User records](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/repositories/userRepository.js): `src/repositories/userRepository.js`

### Template studio

- [Template endpoints](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/routes/template.routes.js): `src/routes/template.routes.js`
- [Template records](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/repositories/templateRepository.js): `src/repositories/templateRepository.js`
- [Page routes](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/routes/page.routes.js): `src/routes/page.routes.js`

### Personalized rendering

- [PNG render endpoint](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/routes/render.routes.js): `src/routes/render.routes.js`
- [Image loading](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/services/images.js): `src/services/images.js`
- [Memory caches](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/lib/cache.js): `src/lib/cache.js`

### Storage and integrations

- [Render metrics](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/lib/metrics.js): `src/lib/metrics.js`
- [Schema setup](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/db/schema.js): `src/db/schema.js`
- [MySQL](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/config/db.js): `src/config/db.js`
- [Redis](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/config/redis.js): `src/config/redis.js`
- [S3 object storage](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/config/s3.js): `src/config/s3.js`
- [WebEngage SMS](https://github.com/suraj4127/pixelforge-dynamic-images/blob/main/src/services/webengage.js): `src/services/webengage.js`

### Other components

- **Studio user**

## Connections

- Studio user → Studio UI: uses (evidence: `README.md`)
- Studio UI → HTTP app: requests pages and APIs
- Server process → HTTP app: starts (evidence: `src/server.js`)
- HTTP app → Account endpoints: mounts routes
- HTTP app → Template endpoints: mounts routes
- HTTP app → PNG render endpoint: mounts routes
- HTTP app → Page routes: mounts routes
- Account endpoints → User records: reads and writes (evidence: `src/routes/auth.routes.js`)
- Account endpoints → Password hashing: hashes and verifies (evidence: `src/routes/auth.routes.js`)
- Account endpoints → Session handling: sets and clears sessions (evidence: `src/routes/auth.routes.js`)
- Account endpoints → Phone verification: issues and verifies codes (evidence: `src/routes/auth.routes.js`)
- Account endpoints → WebEngage SMS: sends verification SMS (evidence: `src/routes/auth.routes.js`)
- Account endpoints → Access guards: checks admin access (evidence: `src/routes/auth.routes.js`)
- Access guards → User records: loads current role (evidence: `src/middleware/guards.js`)
- Access guards → Schema setup: ensures account schema (evidence: `src/middleware/guards.js`)
- Session handling → User records: resolves session user
- Template endpoints → Access guards: protects studio routes (evidence: `src/routes/template.routes.js`)
- Template endpoints → Template records: reads and writes (evidence: `src/routes/template.routes.js`)
- Template endpoints → Image loading: loads upload background (evidence: `src/routes/template.routes.js`)
- Template endpoints → S3 object storage: uploads background (evidence: `src/routes/template.routes.js`)
- Template endpoints → Redis: caches and invalidates templates (evidence: `src/routes/template.routes.js`)
- Template endpoints → Memory caches: clears image caches (evidence: `src/routes/template.routes.js`)
- Template records → MySQL: queries template rows (evidence: `src/repositories/templateRepository.js`)
- PNG render endpoint → Template records: loads template (evidence: `src/routes/render.routes.js`)
- PNG render endpoint → Schema setup: ensures template schema (evidence: `src/routes/render.routes.js`)
- PNG render endpoint → Redis: reads and caches renders (evidence: `src/routes/render.routes.js`)
- PNG render endpoint → Image loading: loads background and overlays (evidence: `src/routes/render.routes.js`)
- PNG render endpoint → Memory caches: uses image caches (evidence: `src/routes/render.routes.js`)
- PNG render endpoint → Render metrics: records render metrics (evidence: `src/routes/render.routes.js`)
- Image loading → Redis: uses shared cache (evidence: `src/services/images.js`)
- Image loading → Memory caches: uses local caches (evidence: `src/services/images.js`)
- Schema setup → MySQL: creates and updates tables (evidence: `src/db/schema.js`)
- Phone verification → Redis: stores verification codes (evidence: `src/services/otp.js`)
- Page routes → Access guards: gates pages (evidence: `src/routes/page.routes.js`)
