# brandon-gomez/booksharing_socialnetwork architecture

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

- Interactive diagram: https://gitdiagram.com/brandon-gomez/booksharing_socialnetwork
- Repository: https://github.com/brandon-gomez/booksharing_socialnetwork

## Overview

##### Project type and purpose
- This is a full-stack web application composed of:
- A Vue.js single-page frontend (directory “fronvue”)
- A Node.js/Express backend API (directory “backnode”)
- A MySQL (or compatible SQL) database (SQL dumps in backnode)
- Firebase as an external file storage service
- Local filesystem storage for uploaded PDFs (backnode/uploads)
- The app exposes REST endpoints for users, posts, likes, follows, categories, file uploads, and admin functions. JWT middleware secures protected routes.

##### File structure
- Top-level directories:
backnode/             ← Express API
- app/index.js      ← server bootstrap
- controllers/      ← MVC controllers
- models/           ← ORM or model definitions
- routes/           ← Express route definitions
- database/         ← DB connection and Firebase setup
- middlewares/      ← JWT authentication
- uploads/          ← local file storage for book PDFs and profile images
- .env              ← secrets (DB creds, JWT secret, Firebase key path)
fronvue/              ← Vue CLI frontend
- .env              ← API endpoints, Firebase config
- babel.config.js
- jsconfig.json
- dist/             ← compiled production assets
- Build & run: uses “concurrently” to start backnode in dev mode and serve the Vue app.

##### Key insights from README
- You must import the SQL schema (bd-27-5.sql) into your local database.
- You need a Firebase service-account JSON and a .env file for private keys.
- Run both servers in parallel:
concurrently "npm run dev --prefix backnode" "npm run serve --prefix fronvue"

##### Detail
- Environment variables feeding into components (.env → DB connection, JWT secret, Firebase JSON).
- Don’t omit the build/deploy boundary—dist/ assets vs. dynamic API.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend Layer"
        SPA["Vue SPA"]:::frontend
        FEENV[".env"]:::config
    end

    %% Backend Layer
    subgraph "Backend Layer"
        BINDEX["app/index.js"]:::backend
        BENV[".env"]:::config

        subgraph "Routes"
            AR["admin_route.js"]
            CR["category_route.js"]
            FR["follow_route.js"]
            LR["like_route.js"]
            PR["post_route.js"]
            UR["upload_route.js"]
            UR2["user_route.js"]
        end

        subgraph "Controllers"
            AC["admin_controller.js"]
            CC["category_controller.js"]
            FC["follow_controller.js"]
            LC["like_controller.js"]
            PC["post_controller.js"]
            UC["upload_controller.js"]
            UC2["user_controller.js"]
            FUC["firebaseupload_controller.js"]
        end

        subgraph "Models"
            AM["category_model.js"]
            BM["follow_model.js"]
            CM["like_model.js"]
            DM["post_model.js"]
            EM["user_model.js"]
        end

        subgraph "Database & Services"
            Conn["connection_db.js"]:::backend
            FirebaseSetup["firebase.js"]:::backend
            SQLSchema["bd-27-5.sql"]:::config
            DB[(MySQL DB)]:::db
        end

        JWT["jwt.middleware.js"]:::auth
        Uploads["Local Uploads"]:::storage
    end

    %% External Service
    subgraph "External Services"
        FIRE["Firebase Storage"]:::cloud
    end

    %% Data Flows
    SPA -->|"REST calls (login, CRUD, file-upload)"| BINDEX
    SPA -->|"Loads API endpoint config"| FEENV
    BINDEX -->|"loads config"| BENV
    BINDEX -->|"registers routes"| AR & CR & FR & LR & PR & UR & UR2
    AR & CR & FR & LR & PR & UR & UR2 -->|"invoke"| AC & CC & FC & LC & PC & UC & UC2 & FUC
    AR & CR & FR & LR & PR & UR & UR2 -->|"JWT auth"| JWT
    AC & CC & FC & LC & PC & UC & UC2 & FUC -->|"use models"| AM & BM & CM & DM & EM
    AM & BM & CM & DM & EM -->|"SQL queries"| DB
    Conn -->|"connects to"| DB
    BINDEX -->|"init DB & Firebase"| Conn & FirebaseSetup
    FUC -->|"Firebase.upload() / download() "| FirebaseSetup --> FIRE
    AC & CC & FC & LC & PC & UC & UC2 -->|"write/read files"| Uploads
    FIRE -->|"public URLs"| SPA

    %% Click Events
    click SPA "https://github.com/brandon-gomez/booksharing_socialnetwork/tree/main/fronvue/"
    click FEENV "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/fronvue/.env"
    click BINDEX "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/app/index.js"
    click BENV "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/.env"
    click AR "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/routes/admin_route.js"
    click CR "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/routes/category_route.js"
    click FR "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/routes/follow_route.js"
    click LR "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/routes/like_route.js"
    click PR "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/routes/post_route.js"
    click UR "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/routes/upload_route.js"
    click UR2 "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/routes/user_route.js"
    click AC "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/controllers/admin_controller.js"
    click CC "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/controllers/category_controller.js"
    click FC "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/controllers/follow_controller.js"
    click LC "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/controllers/like_controller.js"
    click PC "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/controllers/post_controller.js"
    click UC "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/controllers/upload_controller.js"
    click UC2 "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/controllers/user_controller.js"
    click FUC "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/controllers/firebaseupload_controller.js"
    click AM "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/models/category_model.js"
    click BM "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/models/follow_model.js"
    click CM "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/models/like_model.js"
    click DM "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/models/post_model.js"
    click EM "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/models/user_model.js"
    click Conn "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/database/connection_db.js"
    click FirebaseSetup "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/database/firebase.js"
    click SQLSchema "https://github.com/brandon-gomez/booksharing_socialnetwork/blob/main/backnode/bd-27-5.sql"
    click Uploads "https://github.com/brandon-gomez/booksharing_socialnetwork/tree/main/backnode/uploads/"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#0366d6,color:#0366d6,stroke-width:1px;
    classDef backend fill:#E8F8D0,stroke:#28a745,color:#28a745,stroke-width:1px;
    classDef db fill:#E2FFE2,stroke:#1b7c1b,color:#1b7c1b,stroke-width:1px;
    classDef auth fill:#FFE2E2,stroke:#d63333,color:#d63333,stroke-width:1px;
    classDef cloud fill:#F0F8FF,stroke:#1c7ed6,color:#1c7ed6,stroke-width:1px,stroke-dasharray: 5 5;
    classDef storage fill:#FFF4E6,stroke:#d97706,color:#d97706,stroke-width:1px;
    classDef config fill:#F8F9FA,stroke:#6c757d,color:#6c757d,stroke-width:1px;
```
