# deep0902/url-shortner architecture

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

- Interactive diagram: https://gitdiagram.com/deep0902/url-shortner
- Repository: https://github.com/deep0902/url-shortner

## Overview

##### Project Type and Purpose
- This is a modern, full-stack URL shortener application.
- Frontend: React + TypeScript + Vite, served on Vercel.
- Backend: Node.js + Express + MongoDB (using Mongoose), deployed on Vercel.
- Purpose: allow users to register/login, shorten URLs, redirect short URLs, track statistics, and generate QR codes.

##### High-Level Architecture & Main Components
- Frontend Application
- React components (src/components, Reactbits)
- ThemeContext, shared utilities (lib/utils.ts)
- Service worker (dev-dist/registerSW.js) for PWA features
- Vite build and config (vite.config.ts)
- Backend API
- Express server (backend/index.js)
- Routing layer (routes/…)
- Controller logic (controllers/…)
- Middlewares (auth, rate limiting, compression)
- Data models (Mongoose schemas in models/…)
- Database
- MongoDB Atlas cluster (environment-configured)
- External Services
- Vercel for hosting frontend and backend
- MongoDB Atlas
- Optional: third-party QR code generation library

##### Component Relationships and Data Flow
- User interacts with React UI ➔ React component calls Axios against REST API (backend).
- Frontend HTTP requests hit Express routes:
- /api/register, /api/login ➔ loginController.js / userController.js
- /api/shorten ➔ urlController.js
- /api/stats ➔ urlController.js
- /:shortUrl ➔ redirectRoutes ➔ urlController.js
- Controllers talk to Mongoose models (users.model.js, url.model.js).
- Models read/write to MongoDB Atlas.
- On protected routes, auth middleware validates JWT / API key.
- Express uses other middlewares (rate limiter, compression).
- Responses (JSON, redirect status) return to frontend for rendering.

##### Architectural Patterns and Key Principles
- MVC-like separation: Routes → Controllers → Models.
- RESTful API design for CRUD operations.
- JWT and API-key based authentication and authorization.
- Environment-based configuration (.env, VERCEL env).
- Component-based UI in React; context for theme & shared state.
- Progressive enhancement via service worker.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        ReactApp["Frontend: React + TypeScript + Vite"]:::ui
        Components["Components<br/>(src/components)"]:::ui
        Reactbits["Reactbits<br/>(src/Reactbits)"]:::ui
        ThemeContext["ThemeContext.tsx"]:::ui
        Utils["utils.ts<br/>(src/lib/utils.ts)"]:::ui
        ServiceWorker["PWA SW Reg.<br/>(dev-dist/registerSW.js)"]:::ui
        ViteConfig["vite.config.ts"]:::ui
        FrontendVercel["vercel.json"]:::ui
    end

    %% Backend Layer
    subgraph "Backend Layer"
        direction TB
        Server["Express Server<br/>(index.js)"]:::server

        subgraph "Middlewares"
            direction TB
            AuthMw["Auth Middleware<br/>(auth.js)"]:::server
            RateCompMw["Rate Limiter & Compression<br/>(middlewares/)"]:::server
        end

        subgraph "Routes"
            direction TB
            ApiRoutes["apiRoutes.js"]:::server
            LoginRoutes["loginRoutes.js"]:::server
            UserRoutes["userRoutes.js"]:::server
            RedirectRoutes["redirectRoutes.js"]:::server
        end

        subgraph "Controllers"
            direction TB
            UserCtrl["userController.js"]:::server
            LoginCtrl["loginController.js"]:::server
            UrlCtrl["urlController.js"]:::server
        end

        subgraph "Models"
            direction TB
            UserModel["users.model.js"]:::server
            UrlModel["url.model.js"]:::server
        end
        BackendVercel["vercel.json"]:::server
    end

    %% Database Layer
    subgraph "Database Layer"
        direction TB
        MongoDB["MongoDB Atlas"]:::db
    end

    %% External Services
    subgraph "External Services"
        direction TB
        VercelCloud["Vercel Hosting"]:::ext
        QRLib["QR Code Library"]:::ext
    end

    %% Data Flow
    ReactApp -->|Axios HTTP| ApiRoutes
    ReactApp -->|Service Worker Cache| ServiceWorker
    ApiRoutes -->|routes aggregate| Server
    Server --> AuthMw
    AuthMw --> RateCompMw
    RateCompMw --> UserRoutes
    RateCompMw --> LoginRoutes
    RateCompMw --> ApiRoutes
    RateCompMw --> RedirectRoutes
    UserRoutes --> UserCtrl
    LoginRoutes --> LoginCtrl
    RedirectRoutes --> UrlCtrl
    UrlCtrl --> UserModel
    UrlCtrl --> UrlModel
    UserCtrl --> UserModel
    LoginCtrl --> UserModel
    UserModel --> MongoDB
    UrlModel --> MongoDB
    UrlCtrl --> QRLib
    VercelCloud --> ReactApp
    VercelCloud --> Server

    %% Click Events
    click ReactApp "https://github.com/deep0902/url-shortner/tree/main/frontend/"
    click Components "https://github.com/deep0902/url-shortner/tree/main/frontend/src/components/"
    click Reactbits "https://github.com/deep0902/url-shortner/tree/main/frontend/src/Reactbits/"
    click ThemeContext "https://github.com/deep0902/url-shortner/blob/main/frontend/src/ThemeContext.tsx"
    click Utils "https://github.com/deep0902/url-shortner/blob/main/frontend/src/lib/utils.ts"
    click ServiceWorker "https://github.com/deep0902/url-shortner/blob/main/frontend/dev-dist/registerSW.js"
    click ViteConfig "https://github.com/deep0902/url-shortner/blob/main/frontend/vite.config.ts"
    click FrontendVercel "https://github.com/deep0902/url-shortner/blob/main/frontend/vercel.json"
    click Server "https://github.com/deep0902/url-shortner/blob/main/backend/index.js"
    click BackendVercel "https://github.com/deep0902/url-shortner/blob/main/backend/vercel.json"
    click ApiRoutes "https://github.com/deep0902/url-shortner/blob/main/backend/routes/apiRoutes.js"
    click LoginRoutes "https://github.com/deep0902/url-shortner/blob/main/backend/routes/loginRoutes.js"
    click UserRoutes "https://github.com/deep0902/url-shortner/blob/main/backend/routes/userRoutes.js"
    click RedirectRoutes "https://github.com/deep0902/url-shortner/blob/main/backend/routes/redirectRoutes.js"
    click AuthMw "https://github.com/deep0902/url-shortner/blob/main/backend/middlewares/auth.js"
    click RateCompMw "https://github.com/deep0902/url-shortner/tree/main/backend/middlewares/"
    click UserCtrl "https://github.com/deep0902/url-shortner/blob/main/backend/controllers/userController.js"
    click LoginCtrl "https://github.com/deep0902/url-shortner/blob/main/backend/controllers/loginController.js"
    click UrlCtrl "https://github.com/deep0902/url-shortner/blob/main/backend/controllers/urlController.js"
    click UserModel "https://github.com/deep0902/url-shortner/blob/main/backend/models/users.model.js"
    click UrlModel "https://github.com/deep0902/url-shortner/blob/main/backend/models/url.model.js"

    %% Styles
    classDef ui fill:#DAE8FC,stroke:#6C8EBF,color:#000
    classDef server fill:#D5E8D4,stroke:#82B366,color:#000
    classDef db fill:#FFE6CC,stroke:#D79B00,color:#000
    classDef ext fill:#E0E0E0,stroke:#999999,color:#000
```
