# shareeep/fishmuggers-is216 architecture

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

- Interactive diagram: https://gitdiagram.com/shareeep/fishmuggers-is216
- Repository: https://github.com/shareeep/fishmuggers-is216

## Overview

##### Project type and purpose
- This is a full‑stack web application (“PetConnect”) that connects pet owners via social feeds, events, calendars, chat, and maps.
- Frontend: Vue 3 + Vite + Tailwind CSS application that runs in the browser.
- Backend: Node.js + Express REST API that proxies data to/from Firebase (Firestore, Auth, Storage).
- External services: Firebase (Auth, Database, Storage), Google Maps API.

##### File structure
- Top‑level:
· backend/ – Express app (app.js, routes, middleware, services/firebase.js)
· frontend/ – Vue app (src/, public/, configs)
- Patterns:
· “routes → controllers” style in backend (calendar, events, friends, messages, pets, posts, users).
· Middleware for auth/token validation and file upload.
· Service layer (services/firebase.js) encapsulating Firebase Admin interactions.
· Frontend uses Vue Router, separates Public vs Protected areas, and has an API service wrapper (src/services/api.js).
- Config & deployment: .env.example in both frontend/backend, Vite and PostCSS configs, Render.com deployment instructions in README.

##### Key insights from README
- Features: Pet posts feed, Events listings, Personal Calendar, Friends management, Profiles, Real‑time Chats.
- Deployment: Frontend as static site, Backend as web service on Render, environment variables for Firebase keys & backend URL.

1) Client Browser (Vue SPA)
2) Static Hosting / CDN (serving the built Vue app)
3) REST API Server (Node.js + Express)
4) Firebase Suite
– Authentication (Auth)
– Data Store (Firestore / Realtime DB)
– File Storage (Storage for images)
5) External API (Google Maps)
- Browser → Static Host (GET /index.html, app.js, assets)
- Browser → Google Maps API (for map rendering)
- Browser → REST API Server (HTTP calls via src/services/api.js)
- Browser ↔ Firebase Auth SDK (login, token retrieval)
- REST API Server → Firebase Admin SDK (reads/writes Firestore, uploads to Storage)
c. Architectural patterns & principles:
- Separation of concerns (Presentation layer vs API vs Data layer)
- Layered design in backend: Routes → Middleware (auth, upload) → Services → Firebase
- SPA routing (Public vs Protected) in frontend
- Token‑based stateless authentication: client stores JWT from backend or Firebase, attaches on API calls
d. Technologies/frameworks to annotate:
- Frontend: Vue 3, Vue Router, Vite, Tailwind CSS, Firebase JS SDK, Google Maps JS API
- Backend: Node.js, Express.js, Firebase Admin SDK, multer (upload middleware), dotenv
- Deployment: Render.com (Static Site + Web Service)

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Frontend (Vue 3 SPA)"
        direction TB
        Browser["Client Browser"]:::frontend
        VueApp["Vue SPA"]:::frontend
        Router["Vue Router"]:::frontend
        PublicLayout["PublicLayout.vue"]:::frontend
        ProtectedLayout["ProtectedLayout.vue"]:::frontend
        APIService["api.js (HTTP Client)"]:::frontend
        FirebaseSDK["Firebase JS SDK"]:::frontend
        MapsLoader["Google Maps Loader"]:::frontend
        Assets["Static Assets"]:::frontend
    end

    StaticHost["Static Hosting/CDN"]:::external

    subgraph "Backend (Express API)"
        direction TB
        ExpressApp["app.js"]:::backend
        subgraph "Routes"
            direction TB
            RoutesPosts["posts.js"]:::backend
            RoutesEvents["events.js"]:::backend
            RoutesUsers["users.js"]:::backend
            RoutesFriends["friends.js"]:::backend
            RoutesMessages["messages.js"]:::backend
            RoutesCalendar["calendar.js"]:::backend
            RoutesPets["pets.js"]:::backend
        end
        subgraph "Middleware"
            direction TB
            AuthMW["auth.js"]:::backend
            UploadMW["upload.js"]:::backend
        end
        ServiceFirebase["firebase.js (Admin Service)"]:::backend
    end

    subgraph "Firebase Suite"
        direction TB
        FirebaseAuth["Auth"]:::external
        Firestore["Firestore"]:::external
        Storage["Storage"]:::external
    end

    GoogleMapsAPI["Google Maps API"]:::external

    %% Connections
    Browser -->|"loads app"| StaticHost
    StaticHost --> VueApp
    VueApp --> Router
    VueApp --> Assets
    VueApp --> APIService
    VueApp --> FirebaseSDK
    VueApp --> MapsLoader
    MapsLoader --> GoogleMapsAPI
    APIService -->|"REST calls"| ExpressApp
    FirebaseSDK -->|"Auth SDK calls"| FirebaseAuth

    ExpressApp -->|"uses Routes"| RoutesPosts
    ExpressApp -->|"uses Routes"| RoutesEvents
    ExpressApp -->|"uses Routes"| RoutesUsers
    ExpressApp -->|"uses Routes"| RoutesFriends
    ExpressApp -->|"uses Routes"| RoutesMessages
    ExpressApp -->|"uses Routes"| RoutesCalendar
    ExpressApp -->|"uses Routes"| RoutesPets
    ExpressApp -->|"applies"| AuthMW
    ExpressApp -->|"applies"| UploadMW
    AuthMW -->|"validates token"| FirebaseAuth
    UploadMW -->|"uploads media"| Storage
    ServiceFirebase -.->|"Admin SDK"| FirebaseAuth
    ServiceFirebase -.->|"Admin SDK"| Firestore
    ServiceFirebase -.->|"Admin SDK"| Storage
    ExpressApp --> ServiceFirebase
    RoutesPosts --> ServiceFirebase
    RoutesEvents --> ServiceFirebase
    RoutesUsers --> ServiceFirebase
    RoutesFriends --> ServiceFirebase
    RoutesMessages --> ServiceFirebase
    RoutesCalendar --> ServiceFirebase
    RoutesPets --> ServiceFirebase

    %% Click Events
    click VueApp "https://github.com/shareeep/fishmuggers-is216/tree/main2.0/frontend/src/"
    click Router "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/frontend/src/router/index.js"
    click PublicLayout "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/frontend/src/layouts/PublicLayout.vue"
    click ProtectedLayout "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/frontend/src/layouts/ProtectedLayout.vue"
    click APIService "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/frontend/src/services/api.js"
    click FirebaseSDK "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/frontend/firebase.js"
    click MapsLoader "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/frontend/googleMapsLoader.js"
    click Assets "https://github.com/shareeep/fishmuggers-is216/tree/main2.0/frontend/src/assets/"
    click ExpressApp "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/backend/app.js"
    click RoutesPosts "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/backend/routes/posts.js"
    click RoutesEvents "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/backend/routes/events.js"
    click RoutesUsers "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/backend/routes/users.js"
    click RoutesFriends "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/backend/routes/friends.js"
    click RoutesMessages "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/backend/routes/messages.js"
    click RoutesCalendar "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/backend/routes/calendar.js"
    click RoutesPets "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/backend/routes/pets.js"
    click AuthMW "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/backend/middleware/auth.js"
    click UploadMW "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/backend/middleware/upload.js"
    click ServiceFirebase "https://github.com/shareeep/fishmuggers-is216/blob/main2.0/backend/services/firebase.js"

    classDef frontend fill:#a2f5a2,stroke:#333,stroke-width:1px
    classDef backend fill:#a2c8f2,stroke:#333,stroke-width:1px
    classDef external fill:#f5d88a,stroke:#333,stroke-width:1px
    class VueApp,Router,PublicLayout,ProtectedLayout,APIService,FirebaseSDK,MapsLoader,Assets frontend
    class ExpressApp,RoutesPosts,RoutesEvents,RoutesUsers,RoutesFriends,RoutesMessages,RoutesCalendar,RoutesPets,AuthMW,UploadMW,ServiceFirebase backend
    class StaticHost,FirebaseAuth,Firestore,Storage,GoogleMapsAPI external
```
