# gcvishwas/e-commerce-book-store architecture

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

- Interactive diagram: https://gitdiagram.com/gcvishwas/e-commerce-book-store
- Repository: https://github.com/gcvishwas/e-commerce-book-store

## Overview

##### Project Type and Purpose
- This is a full-stack e-commerce Book Store.
- Frontend: React + Redux + Firebase, served as a static SPA (deployed on Vercel).
- Backend: Node.js + Express + TypeScript with JWT auth, deployed as a serverless or Node service (Vercel).
- Database: MongoDB (hosted on Atlas or self‐managed).
- External services: Firebase (analytics, notifications), potentially email/SMS services.

##### Main Components
a. Frontend SPA
- React app (components, pages)
- Redux store (features: books, cart, orders)
- React-Router (public vs. private vs. admin routes)
- Firebase integration (config, analytics/auth backup)
b. API Gateway / Server
- Express server (index.ts)
- Middleware (JWT validation, verifyAdmin)
- Routes layer (/routes)
- Controllers (/controllers: user, book, order)
- Business modules (/modules: user_data, book_store, orders_data)
- DB utils (/utils/db.ts)
c. Database
- MongoDB collections: users, books, orders
d. External Services
- Firebase (analytics, notifications)
- Vercel (hosting for both frontend & backend)
- (Optionally) Email/SMS provider

##### Relationships & Data Flows
- User’s Browser → (HTTPS) → Frontend (static assets)
- Frontend → (HTTPS, JSON) → Backend API endpoints
- Public endpoints: sign up, login, browse/search books
- Protected endpoints (JWT): cart management, place orders
- Admin endpoints (JWT + verifyAdmin): add/edit/delete books & users
- Backend → MongoDB
- Controllers invoke modules → DB utils execute CRUD
- Frontend → Firebase
- Analytics events, optional notifications
- Deployment platform (Vercel) hosts both front and back

##### Architectural Patterns & Design Principles
- Backend follows a layered MVC-style pattern:
Routes → Controllers → Domain Modules → DB Utils
- Stateless JWT authentication, middleware for access control
- Frontend uses unidirectional data flow (Redux) + Context for auth state
- Component decomposition: layout, pages, reusable components
- Separation of concerns: UI vs. state vs. side effects (API calls)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend (React + Redux + Firebase)" 
        direction TB
        Browser["User Browser"]:::external
        FE_APP["React SPA"]:::frontend
        FE_STORE["Redux Store"]:::frontend
        FE_ROUTER["React-Router"]:::frontend
        FE_COMP["UI Components"]:::frontend
        FE_PAGES["Pages (Home, Books, Dashboard)"]:::frontend
        FE_FB["Firebase Integration"]:::external

        Browser -->|"Loads static assets"| FE_APP
        FE_APP -->|"uses"| FE_STORE
        FE_APP -->|"uses"| FE_ROUTER
        FE_APP -->|"renders"| FE_COMP
        FE_APP -->|"navigates"| FE_PAGES
        FE_APP -->|"sends analytics/events"| FE_FB
    end

    %% Backend Layer
    subgraph "Backend (Node.js + Express + TypeScript)" 
        direction TB
        BE_SERVER["HTTP Server (index.ts)"]:::backend
        BE_MW["Middleware (JWT & Admin)"]:::backend
        subgraph "Routes Layer"
            direction TB
            BE_USER_ROUTE["User Routes"]:::backend
            BE_BOOK_ROUTE["Book Routes"]:::backend
            BE_ORDER_ROUTE["Order Routes"]:::backend
        end
        subgraph "Controllers Layer"
            direction TB
            BE_USER_CTRL["User Controller"]:::backend
            BE_BOOK_CTRL["Book Controller"]:::backend
            BE_ORDER_CTRL["Order Controller"]:::backend
        end
        subgraph "Modules Layer"
            direction TB
            BE_USER_MOD["User Data Module"]:::backend
            BE_BOOK_MOD["Book Store Module"]:::backend
            BE_ORDER_MOD["Orders Data Module"]:::backend
        end
        BE_DB_UTILS["DB Utils (db.ts)"]:::backend

        FE_APP -->|"GET/POST (JSON, JWT)"| BE_SERVER
        BE_SERVER -->|"auth check"| BE_MW
        BE_MW -->|"routes requests"| BE_USER_ROUTE
        BE_MW -->|"routes requests"| BE_BOOK_ROUTE
        BE_MW -->|"routes requests"| BE_ORDER_ROUTE
        BE_USER_ROUTE -->|"calls"| BE_USER_CTRL
        BE_BOOK_ROUTE -->|"calls"| BE_BOOK_CTRL
        BE_ORDER_ROUTE -->|"calls"| BE_ORDER_CTRL
        BE_USER_CTRL -->|"domain logic"| BE_USER_MOD
        BE_BOOK_CTRL -->|"domain logic"| BE_BOOK_MOD
        BE_ORDER_CTRL -->|"domain logic"| BE_ORDER_MOD
        BE_USER_MOD -->|"CRUD ops"| BE_DB_UTILS
        BE_BOOK_MOD -->|"CRUD ops"| BE_DB_UTILS
        BE_ORDER_MOD -->|"CRUD ops"| BE_DB_UTILS
    end

    %% Database Layer
    subgraph "Database (MongoDB)" 
        direction TB
        MongoDB["MongoDB\n(users, books, orders)"]:::database
        BE_DB_UTILS -->|"connects"| MongoDB
    end

    %% External Services
    subgraph "External Services" 
        direction TB
        FirebaseService["Firebase\n(Analytics, Notifications)"]:::external
        Vercel["Vercel Hosting"]:::external
        FE_FB -->|"configured via SDK"| FirebaseService
        Vercel -->|"hosts SPA"| FE_APP
        Vercel -->|"hosts API"| BE_SERVER
    end

    %% Click Events
    click FE_APP "https://github.com/gcvishwas/e-commerce-book-store/tree/main/frontend/src"
    click FE_STORE "https://github.com/gcvishwas/e-commerce-book-store/blob/main/frontend/src/redux/store.js"
    click FE_ROUTER "https://github.com/gcvishwas/e-commerce-book-store/tree/main/frontend/src/routers"
    click FE_FB "https://github.com/gcvishwas/e-commerce-book-store/blob/main/frontend/src/firebase/firebase.config.js"
    click FE_COMP "https://github.com/gcvishwas/e-commerce-book-store/tree/main/frontend/src/components"
    click FE_PAGES "https://github.com/gcvishwas/e-commerce-book-store/tree/main/frontend/src/pages"
    click BE_SERVER "https://github.com/gcvishwas/e-commerce-book-store/blob/main/backend/src/index.ts"
    click BE_MW "https://github.com/gcvishwas/e-commerce-book-store/blob/main/backend/src/middleware/verifyAdmin.ts"
    click BE_USER_ROUTE "https://github.com/gcvishwas/e-commerce-book-store/blob/main/backend/src/routes/user.ts"
    click BE_BOOK_ROUTE "https://github.com/gcvishwas/e-commerce-book-store/blob/main/backend/src/routes/book.ts"
    click BE_ORDER_ROUTE "https://github.com/gcvishwas/e-commerce-book-store/blob/main/backend/src/routes/order.ts"
    click BE_USER_CTRL "https://github.com/gcvishwas/e-commerce-book-store/blob/main/backend/src/controllers/user.ts"
    click BE_BOOK_CTRL "https://github.com/gcvishwas/e-commerce-book-store/blob/main/backend/src/controllers/book.ts"
    click BE_ORDER_CTRL "https://github.com/gcvishwas/e-commerce-book-store/blob/main/backend/src/controllers/order.ts"
    click BE_USER_MOD "https://github.com/gcvishwas/e-commerce-book-store/blob/main/backend/src/modules/user_data.ts"
    click BE_BOOK_MOD "https://github.com/gcvishwas/e-commerce-book-store/blob/main/backend/src/modules/book_store.ts"
    click BE_ORDER_MOD "https://github.com/gcvishwas/e-commerce-book-store/blob/main/backend/src/modules/oders_data.ts"
    click BE_DB_UTILS "https://github.com/gcvishwas/e-commerce-book-store/blob/main/backend/src/utils/db.ts"

    %% Styles
    classDef frontend fill:#cce5ff,stroke:#004085,color:#004085
    classDef backend fill:#d4edda,stroke:#155724,color:#155724
    classDef database fill:#fff3cd,stroke:#856404,color:#856404
    classDef external fill:#e2e3e5,stroke:#383d41,color:#383d41
```
