# anitamavani/contactmanager architecture

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

- Interactive diagram: https://gitdiagram.com/anitamavani/contactmanager
- Repository: https://github.com/anitamavani/contactmanager

## Overview

##### Project Type & Purpose
- Full-stack web application: React + TypeScript frontend + Material-UI, backed by Node.js + Express REST API, persisting data in MySQL.
- Purpose: Allow users to register/login (JWT), then perform CRUD operations on contacts.

##### Main Components
A. Client Layer (Frontend)
- Browser/app running React (TypeScript)
- Uses React Router for navigation, Material-UI for styling
- Pages: Home, About (public), Auth (register/login), Contact (CRUD, protected)
- Authentication context + custom hooks (useAuth, useForm) manage state & API calls

B. API Layer (Backend)
- Express.js application
- Routes:
- /api/auth/* (userRoutes.js)
- /api/contacts/* (contactRoutes.js)
- Middleware:
- CORS & body-parser (global)
- authMiddleware.js (JWT verification)
- contactValidation.js (request payload validation)
- errorHandler.js (centralized error response)
- Controllers invoke business logic:
- userController.js → register/login & JWT generation
- contactController.js → CRUD logic

C. Data Layer
- Models define queries/interactions with MySQL (via mysql2 or similar)
- userModel.js
- contactModel.js
- Configuration: db.js reads connection settings from my.cnf or env

D. External Services
- MySQL database instance
- JWT Signing (using secret from .env)

##### Relationships & Data Flow
1) User interacts with React UI → triggers a page or API action.
2) Frontend uses fetch/axios to call Express endpoints under /api/auth or /api/contacts.
3) On auth routes: userController
→ generates JWT → returned to frontend → stored in context/localStorage
4) For protected /contacts calls: frontend sends JWT in Authorization header → authMiddleware verifies → passes control to contactController.
5) Controllers call model layer → execute SQL queries → return results → middleware/formatted response → frontend.

##### Architectural Patterns & Principles
- MVC-inspired within the backend: Routes → Middleware → Controllers → Models → DB
- Separation of Concerns:
- Frontend UI vs. business logic (controllers) vs. data access (models)
- Centralized middleware for cross-cutting concerns (auth, validation, error handling)
- Stateless API: uses JWT tokens
- Single Monolithic Service (no microservices) but clearly separated folders

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Client Layer (Frontend)"
        direction TB
        Browser["Browser/React UI"]:::external
        FEIndex["index.tsx"]:::frontend
        FEApp["App.tsx"]:::frontend
        FERoutes["routes.tsx"]:::frontend
        subgraph "Pages"
            direction TB
            FEHome["Home.tsx"]:::frontend
            FEAbout["About.tsx"]:::frontend
            FEAuth["Auth.tsx"]:::frontend
            FEContact["Contact.tsx"]:::frontend
        end
        FEHeader["Header.tsx"]:::frontend
        FEAuthContext["AuthContext.tsx"]:::frontend
        FEUseAuth["useAuth.tsx"]:::frontend
        FEUseForm["useForm.tsx"]:::frontend
        FEValidation["Validation.tsx"]:::frontend
        FEValidationRules["ValidationRules.tsx"]:::frontend
    end

    %% Backend Layer
    subgraph "API Layer (Backend)"
        direction TB
        BEApp["app.js"]:::backend
        BEServer["server.js"]:::backend
        BEConfigDB["config/db.js"]:::backend
        BEMyCNF["my.cnf"]:::backend
        subgraph "Routes"
            direction TB
            BEAuthRoutes["userRoutes.js"]:::backend
            BEContactRoutes["contactRoutes.js"]:::backend
        end
        subgraph "Middleware"
            direction TB
            BEAuthMw["authMiddleware.js"]:::middleware
            BEValidationMw["contactValidation.js"]:::middleware
            BEErrorMw["errorHandler.js"]:::middleware
        end
        subgraph "Controllers"
            direction TB
            BEUserCtrl["userController.js"]:::backend
            BEContactCtrl["contactController.js"]:::backend
        end
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        UserModel["userModel.js"]:::database
        ContactModel["contactModel.js"]:::database
        DBConnection["db.js"]:::database
    end

    %% External Services
    subgraph "External Services"
        direction TB
        MySQL["MySQL Database"]:::external
        JWT["JWT Signing Service"]:::external
    end

    %% Connections
    Browser -->|"HTTPS"| BEApp
    BEApp --> BEAuthRoutes
    BEApp --> BEContactRoutes
    BEAuthRoutes --> BEAuthMw
    BEContactRoutes --> BEAuthMw
    BEContactRoutes --> BEValidationMw
    BEAuthMw --> BEUserCtrl
    BEValidationMw --> BEContactCtrl
    BEUserCtrl --> UserModel
    BEContactCtrl --> ContactModel
    UserModel --> DBConnection
    ContactModel --> DBConnection
    DBConnection --> MySQL
    BEUserCtrl --> JWT
    JWT --> BEAuthMw
    BEServer --> BEApp
    BEConfigDB --> DBConnection
    BEMyCNF --> BEConfigDB

    Browser -->|Stores JWT| FEAuthContext
    FEAuthContext -->|API calls| BEApp
    FERoutes --> FEHome
    FERoutes --> FEAbout
    FERoutes --> FEAuth
    FERoutes --> FEContact
    FEApp --> FERoutes
    FEHeader --> FEApp

    %% Click Events
    click FEIndex "https://github.com/anitamavani/contactmanager/blob/main/frontend/src/index.tsx"
    click FEApp "https://github.com/anitamavani/contactmanager/blob/main/frontend/src/App.tsx"
    click FERoutes "https://github.com/anitamavani/contactmanager/blob/main/frontend/src/routes/routes.tsx"
    click FEHome "https://github.com/anitamavani/contactmanager/blob/main/frontend/src/pages/Home.tsx"
    click FEAbout "https://github.com/anitamavani/contactmanager/blob/main/frontend/src/pages/About.tsx"
    click FEAuth "https://github.com/anitamavani/contactmanager/blob/main/frontend/src/pages/Auth.tsx"
    click FEContact "https://github.com/anitamavani/contactmanager/blob/main/frontend/src/pages/Contact.tsx"
    click FEHeader "https://github.com/anitamavani/contactmanager/blob/main/frontend/src/components/Header.tsx"
    click FEAuthContext "https://github.com/anitamavani/contactmanager/blob/main/frontend/src/context/AuthContext.tsx"
    click FEUseAuth "https://github.com/anitamavani/contactmanager/blob/main/frontend/src/hooks/useAuth.tsx"
    click FEUseForm "https://github.com/anitamavani/contactmanager/blob/main/frontend/src/hooks/useForm.tsx"
    click FEValidation "https://github.com/anitamavani/contactmanager/blob/main/frontend/src/utils/Validation.tsx"
    click FEValidationRules "https://github.com/anitamavani/contactmanager/blob/main/frontend/src/utils/ValidationRules.tsx"
    click BEApp "https://github.com/anitamavani/contactmanager/blob/main/backend/src/app.js"
    click BEServer "https://github.com/anitamavani/contactmanager/blob/main/backend/src/server.js"
    click BEConfigDB "https://github.com/anitamavani/contactmanager/blob/main/backend/src/config/db.js"
    click BEMyCNF "https://github.com/anitamavani/contactmanager/blob/main/backend/my.cnf"
    click BEAuthRoutes "https://github.com/anitamavani/contactmanager/blob/main/backend/src/routes/userRoutes.js"
    click BEContactRoutes "https://github.com/anitamavani/contactmanager/blob/main/backend/src/routes/contactRoutes.js"
    click BEAuthMw "https://github.com/anitamavani/contactmanager/blob/main/backend/src/middleware/authMiddleware.js"
    click BEValidationMw "https://github.com/anitamavani/contactmanager/blob/main/backend/src/middleware/contactValidation.js"
    click BEErrorMw "https://github.com/anitamavani/contactmanager/blob/main/backend/src/middleware/errorHandler.js"
    click BEUserCtrl "https://github.com/anitamavani/contactmanager/blob/main/backend/src/controllers/userController.js"
    click BEContactCtrl "https://github.com/anitamavani/contactmanager/blob/main/backend/src/controllers/contactController.js"
    click UserModel "https://github.com/anitamavani/contactmanager/blob/main/backend/src/models/userModel.js"
    click ContactModel "https://github.com/anitamavani/contactmanager/blob/main/backend/src/models/contactModel.js"
    click DBConnection "https://github.com/anitamavani/contactmanager/blob/main/backend/src/config/db.js"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#1E90FF,color:#000
    classDef backend fill:#DFFFE0,stroke:#3CB371,color:#000
    classDef middleware fill:#FFF5BA,stroke:#FFD700,color:#000
    classDef database fill:#FFE4B5,stroke:#FFA500,color:#000
    classDef external fill:#E0E0E0,stroke:#A9A9A9,color:#000
```
