# ivankomorales/haro-mobile architecture

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

- Interactive diagram: https://gitdiagram.com/ivankomorales/haro-mobile
- Repository: https://github.com/ivankomorales/haro-mobile

## Overview

##### Project type and purpose
- This is a RESTful backend API for managing personalized ceramic orders (orders, customers, glazes, users).
- It exposes CRUD endpoints secured by JWT and role-based middleware.
- It uses Node.js/Express on the server side and MongoDB (via Mongoose) for persistence.

##### File structure
- app.js: boots the Express server, loads middleware, mounts routes.
- config/db.js: establishes MongoDB connection.
- routes/*: define HTTP endpoints (auth, user, order, glaze).
- middleware/*: JWT verification, role checks.
- controllers/*: business logic for each resource, orchestrating model operations.
- models/*: Mongoose schemas (User, Customer, Order, Glaze, Counter).
- package.json: lists dependencies (express, mongoose, dotenv, helmet, cors, morgan, jsonwebtoken).

##### README for additional insights
- Uses Helmet, CORS, Morgan for security/logging.
- Auth with JWT; admin role guards destructive operations.
- Auto-incrementing orderID via Counter collection.
- Future integration target: React PWA client.

##### Main components
a. Clients
- External client (Postman or future React PWA)
b. API Server
- Express.js application
- dotenv for config
- Global middleware (helmet, cors, morgan)
- Auth middleware (verifyToken, checkRole)
- Route handlers (authRoutes, userRoutes, orderRoutes, glazeRoutes)
- Controllers for business logic
- Mongoose models/data access layer
c. Database
- MongoDB Atlas or local instance
- Collections: users, customers, orders, glazes, counters
d. External services (future/file storage, PDF/Excel exporter)

##### Relationships and data flow
1. Client → HTTP Request → Express Router
2. Router → Middleware chain (security, JWT verify, role check)
3. Middleware → Controller method
4. Controller → Mongoose Model operations (CRUD)
5. Model → MongoDB read/write
6. Response travels back through Controller → Middleware → Router → Client

##### Architectural patterns and design principles
- Layered architecture: Presentation (routes) → Business (controllers) → Data (models).
- Separation of concerns: security in middleware, business rules in controllers, schema logic in models.
- Configuration via dotenv keeps environment-specific details out of code.
- Atomic orderID generation with a Counter collection for sequential IDs.

##### Technologies, frameworks, libraries
- Node.js, Express.js
- MongoDB, Mongoose
- dotenv, helmet, cors, morgan
- JSON Web Tokens for authentication
- Postman (for testing)
- Future: React PWA client

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Client"
        Client["External Client\n(Postman / React PWA)"]:::client
    end

    subgraph "API Server"
        Express["Express App (app.js)"]:::server
        Config["dotenv + DB Config (config/db.js)"]:::server
        Package["package.json"]:::server
        GM["Helmet / CORS / Morgan"]:::middleware
        AuthMW["JWT Verification Middleware"]:::middleware
        RoleMW["Role-Based Access Control"]:::middleware

        subgraph "Routes"
            AuthRoutes["Auth Routes"]:::router
            UserRoutes["User Routes"]:::router
            OrderRoutes["Order Routes"]:::router
            GlazeRoutes["Glaze Routes"]:::router
        end

        subgraph "Controllers"
            AuthCtrl["Auth Controller"]:::controller
            UserCtrl["User Controller"]:::controller
            OrderCtrl["Order Controller"]:::controller
            GlazeCtrl["Glaze Controller"]:::controller
        end

        subgraph "Models"
            UserModel["User Model"]:::model
            CustomerModel["Customer Model"]:::model
            OrderModel["Order Model"]:::model
            GlazeModel["Glaze Model"]:::model
            CounterModel["Counter Model"]:::model
        end
    end

    subgraph "Database"
        subgraph "MongoDB"
            UsersColl["Users Collection"]:::database
            CustomersColl["Customers Collection"]:::database
            OrdersColl["Orders Collection"]:::database
            GlazesColl["Glazes Collection"]:::database
            CountersColl["Counters Collection"]:::database
        end
    end

    subgraph "External Services (Future)"
        PDFService["PDF / Excel Export Service"]:::service
        FileStorage["File Storage Service"]:::service
    end

    Client -->|HTTP Request| Express
    Express -->|load| Config
    Express -->|dependency info| Package
    Express -->|use| GM
    Express -->|use verifyToken| AuthMW
    Express -->|use checkRole| RoleMW

    Express -->|mount /api/auth| AuthRoutes
    Express -->|mount /api/users| UserRoutes
    Express -->|mount /api/orders| OrderRoutes
    Express -->|mount /api/glazes| GlazeRoutes

    AuthRoutes -->|calls| AuthCtrl
    UserRoutes -->|calls| UserCtrl
    OrderRoutes -->|calls| OrderCtrl
    GlazeRoutes -->|calls| GlazeCtrl

    AuthCtrl -->|CRUD| UserModel
    UserCtrl -->|CRUD Users| UserModel
    UserCtrl -->|CRUD Customers| CustomerModel
    OrderCtrl -->|CRUD Orders| OrderModel
    OrderCtrl -->|Counter logic| CounterModel
    GlazeCtrl -->|CRUD| GlazeModel

    UserModel -->|reads/writes| UsersColl
    CustomerModel -->|reads/writes| CustomersColl
    OrderModel -->|reads/writes| OrdersColl
    GlazeModel -->|reads/writes| GlazesColl
    CounterModel -->|reads/writes| CountersColl

    OrderCtrl -->|export data| PDFService
    OrderCtrl -->|store media| FileStorage

    click Express "https://github.com/ivankomorales/haro-mobile/blob/main/app.js"
    click Config "https://github.com/ivankomorales/haro-mobile/blob/main/config/db.js"
    click Package "https://github.com/ivankomorales/haro-mobile/blob/main/package.json"
    click GM "https://github.com/ivankomorales/haro-mobile/blob/main/app.js"
    click AuthMW "https://github.com/ivankomorales/haro-mobile/blob/main/middleware/auth.js"
    click RoleMW "https://github.com/ivankomorales/haro-mobile/blob/main/middleware/checkRole.js"
    click AuthRoutes "https://github.com/ivankomorales/haro-mobile/blob/main/routes/authRoutes.js"
    click UserRoutes "https://github.com/ivankomorales/haro-mobile/blob/main/routes/userRoutes.js"
    click OrderRoutes "https://github.com/ivankomorales/haro-mobile/blob/main/routes/orderRoutes.js"
    click GlazeRoutes "https://github.com/ivankomorales/haro-mobile/blob/main/routes/glazeRoutes.js"
    click AuthCtrl "https://github.com/ivankomorales/haro-mobile/blob/main/controllers/authController.js"
    click UserCtrl "https://github.com/ivankomorales/haro-mobile/blob/main/controllers/userController.js"
    click OrderCtrl "https://github.com/ivankomorales/haro-mobile/blob/main/controllers/orderController.js"
    click GlazeCtrl "https://github.com/ivankomorales/haro-mobile/blob/main/controllers/glazeController.js"
    click UserModel "https://github.com/ivankomorales/haro-mobile/blob/main/models/User.js"
    click CustomerModel "https://github.com/ivankomorales/haro-mobile/blob/main/models/Customer.js"
    click OrderModel "https://github.com/ivankomorales/haro-mobile/blob/main/models/Order.js"
    click GlazeModel "https://github.com/ivankomorales/haro-mobile/blob/main/models/Glaze.js"
    click CounterModel "https://github.com/ivankomorales/haro-mobile/blob/main/models/Counter.js"

    classDef client fill:#BBDEFB,stroke:#1976D2,color:#0D47A1;
    classDef server fill:#C8E6C9,stroke:#388E3C,color:#1B5E20;
    classDef middleware fill:#FFF9C4,stroke:#FBC02D,color:#F57F17;
    classDef router fill:#FFE0B2,stroke:#F57C00,color:#E65100;
    classDef controller fill:#D1C4E9,stroke:#7E57C2,color:#4A148C;
    classDef model fill:#B2DFDB,stroke:#009688,color:#004D40;
    classDef database fill:#FFCDD2,stroke:#E53935,color:#B71C1C;
    classDef service fill:#E0F7FA,stroke:#00ACC1,color:#006064;
```
