# mohdzain98/curlmin architecture

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

- Interactive diagram: https://gitdiagram.com/mohdzain98/curlmin
- Repository: https://github.com/mohdzain98/curlmin

## Overview

##### Project type and purpose
- Curlmin is a full-stack web application for URL shortening, QR/barcode generation, and “curltags.”
- The frontend is a React single-page app (in src/ and build/), and the backend is a Node.js/Express API (in backend/). It persists data in a MySQL database.

##### File structure
- Top-level:
- public/ & src/: React app sources and static files
- build/: React production build output
- backend/: Express server, routes, models, middleware, custom event emitter
- sitemap-generator.js: build-time script for sitemap.xml
- CI/CD: .github/workflows/main.yml for both root and backend
- Patterns:
- MVC-style backend—models/ for Sequelize or custom ORM wrappers, routes/ for controllers, middleware/ for request interceptors
- EventEmitter-based logic (backend/eventEmitter.js)
- Separation of concerns: mysql.js & db.js abstracts database connection; functions/ houses core utilities
- React Context API for global state (src/Context)

##### README for additional insights
- Confirms core features: URL shortening, QR/barcode, curltags

a. Main components to include
- User Device (Browser/Mobile)
- Frontend (React SPA)
- Backend API (Express Server)
- MySQL Database
- External Services:
– Email service (SMTP) for mail routes
– Optional storage service for background images (if used by curltags)
– CI/CD pipelines (GitHub Actions)
b. Relationships & interactions
- User ↔ Frontend via HTTPS (React UI in browser)
- Frontend ↔ Backend via RESTful API calls (endpoints in backend/routes)
- Backend ↔ MySQL DB for CRUD on URL, User, Count models
- Backend ↔ Email service for verification, password reset
- sitemap-generator.js runs at build time to update sitemap.xml used by search engines
c. Architectural patterns & principles
- MVC separation in backend
- Event-driven logic for asynchronous tasks (eventEmitter.js)
- React component hierarchy and Context API for state management
- CI/CD with GitHub Actions for automated tests and deployments
d. Key technologies & frameworks
- Frontend: React, React Router, Context API, JSX, CSS modules
- Backend: Node.js, Express.js, MySQL, custom event emitter
- Build Tools: Webpack (via create-react-app), npm scripts
- DevOps: GitHub Actions, VSCode launch configs, sitemap-generator

##### Detailed capturing of essential elements
- Sequence of a URL-shortening request:
1. UI submits long URL → POST /core
2. API generates short code → stores in Url model
3. API returns short URL → UI renders and offers QR/barcode
- Redirect flow:
1. User clicks short URL → API route /:code
2. API increments Urlcount → eventEmitter triggers analytics function → redirects to original URL
- Context Providers in React (UserState, userContext) managing global user/session state

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    subgraph "Client Layer"
        direction TB
        Browser["User Device (Browser/Mobile)"]:::external
        subgraph "React SPA" 
            direction TB
            SRC["Source (src/)"]:::frontend
            INDEX["index.js"]:::frontend
            APP["App.js"]:::frontend
            COMPONENTS["Components/"]:::frontend
            CONTEXT["Context Providers"]:::frontend
            USERSTATE["UserState.js"]:::frontend
            USERCTX["userContext.js"]:::frontend
            USERACC["UserAccount.js"]:::frontend
            PUBLIC["Public/"]:::frontend
        end
        BUILD["Production Build (build/)"]:::pipeline
    end

    %% Server Layer
    subgraph "Server Layer"
        direction TB
        API["Express Server (backend/index.js)"]:::backend
        subgraph "API Routes"
            direction TB
            AUTH["auth.js"]:::backend
            CORE["core.js"]:::backend
            MAIL["mail.js"]:::backend
            REDIRECT["redirect.js"]:::backend
            UPDATE["updateCount.js"]:::backend
            USER["user.js"]:::backend
        end
        MIDDLEWARE["fetchuser.js"]:::backend
        EVENTS["eventEmitter.js"]:::backend
        DBABSTR["DB Abstraction"]:::backend
        MYSQLJS["mysql.js"]:::backend
        DBJS["db.js"]:::backend
        UTIL["Functions.js"]:::backend
    end

    %% Database
    DB[(MySQL Database)]:::db

    %% External Services
    subgraph "External Services"
        direction TB
        SMTP["Email Service (SMTP)"]:::external
        STORAGE["Image Storage Service"]:::external
    end

    %% CI/CD
    subgraph "CI/CD Pipelines"
        direction TB
        CI_ROOT[".github/workflows/main.yml"]:::pipeline
        CI_BACKEND["backend/.github/workflows/main.yml"]:::pipeline
    end

    %% Build & Deploy
    SRC -->|build| BUILD
    BUILD -->|deploy to CDN/web server| Browser

    %% Client to Server
    Browser -->|HTTPS| APP
    APP -->|REST API calls| API

    %% API internals
    API --> AUTH
    API --> CORE
    API --> MAIL
    API --> REDIRECT
    API --> UPDATE
    API --> USER
    AUTH --- MIDDLEWARE
    CORE --- UTIL
    MAIL --- UTIL
    REDIRECT --- EVENTS
    UPDATE --- UTIL
    USER --- UTIL

    %% API to DB
    API -->|CRUD operations| DB
    DBABSTR --- MYSQLJS
    DBABSTR --- DBJS
    API --- DBABSTR

    %% External interactions
    API -->|send emails| SMTP
    CORE -->|store images| STORAGE

    %% CI/CD triggers
    SRC --> CI_ROOT
    backend/index.js --> CI_BACKEND

    %% Classes
    classDef frontend fill:#D0E8FF,stroke:#0055AA,color:#0055AA;
    classDef backend fill:#DFFFE0,stroke:#2E7D32,color:#2E7D32;
    classDef db fill:#FFE0B2,stroke:#E65100,color:#E65100;
    classDef external fill:#F2F2F2,stroke:#999999,color:#555555;
    classDef pipeline stroke-dasharray: 5 5,fill:#FFFFFF,stroke:#888888,color:#888888;

    %% Click Events
    click SRC "https://github.com/mohdzain98/curlmin/tree/main/src/"
    click INDEX "https://github.com/mohdzain98/curlmin/blob/main/src/index.js"
    click APP "https://github.com/mohdzain98/curlmin/blob/main/src/App.js"
    click COMPONENTS "https://github.com/mohdzain98/curlmin/tree/main/src/Components/"
    click USERSTATE "https://github.com/mohdzain98/curlmin/blob/main/src/Context/UserState.js"
    click USERCTX "https://github.com/mohdzain98/curlmin/blob/main/src/Context/userContext.js"
    click USERACC "https://github.com/mohdzain98/curlmin/blob/main/src/Context/UserAccount.js"
    click PUBLIC "https://github.com/mohdzain98/curlmin/tree/main/public/"
    click BUILD "https://github.com/mohdzain98/curlmin/tree/main/build/"
    click API "https://github.com/mohdzain98/curlmin/blob/main/backend/index.js"
    click AUTH "https://github.com/mohdzain98/curlmin/blob/main/backend/routes/auth.js"
    click CORE "https://github.com/mohdzain98/curlmin/blob/main/backend/routes/core.js"
    click MAIL "https://github.com/mohdzain98/curlmin/blob/main/backend/routes/mail.js"
    click REDIRECT "https://github.com/mohdzain98/curlmin/blob/main/backend/routes/redirect.js"
    click UPDATE "https://github.com/mohdzain98/curlmin/blob/main/backend/routes/updateCount.js"
    click USER "https://github.com/mohdzain98/curlmin/blob/main/backend/routes/user.js"
    click MYSQLJS "https://github.com/mohdzain98/curlmin/blob/main/backend/mysql.js"
    click DBJS "https://github.com/mohdzain98/curlmin/blob/main/backend/db.js"
    click UTIL "https://github.com/mohdzain98/curlmin/blob/main/backend/functions/Functions.js"
    click EVENTS "https://github.com/mohdzain98/curlmin/blob/main/backend/eventEmitter.js"
    click CI_ROOT "https://github.com/mohdzain98/curlmin/blob/main/.github/workflows/main.yml"
    click CI_BACKEND "https://github.com/mohdzain98/curlmin/blob/main/backend/.github/workflows/main.yml"
```
