# abdelrahmantarek790/tahyamisrsite architecture

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

- Interactive diagram: https://gitdiagram.com/abdelrahmantarek790/tahyamisrsite
- Repository: https://github.com/abdelrahmantarek790/tahyamisrsite

## Overview

##### Project Type and Purpose
- This is a full-stack “Platform” solution composed of:
a) A React/Vite “client” web app with SSR and SEO support
b) A Flutter “mobile” application for iOS/Android/Linux/Windows/macOS
c) A Node.js/Express “backend API” monolith backed by MongoDB
- Purpose: Provide a unified Students Union platform for Admin, Volunteers, and Students, supporting user management, events, news, media, positions, join-requests, push notifications, file uploads, and role-based access control.

##### File Structure Analysis
- Top-level folders:
- client/ – React SSR + static assets + Docker/Nginx deployment
- mobile/ – Flutter multi-platform app with feature modules
- config/, controllers/, models/, routes/, middleware/, utils/ – Node.js API monolith
- uploads/ – file storage for images/videos
- Config files: .env.example, Dockerfiles, nginx.conf, seed.js, server.js
- Patterns:
- Frontends (client & mobile) are separate consumers of the same API
- API layer follows MVC-like organization: routes → controllers → models (Mongoose)
- Middleware layer for auth, error handling, CORS, Helmet
- Utility layer for file upload (Multer), validation (Joi), Firebase notifications

##### Key README Insights
- Backend stack: Express, MongoDB, Mongoose, JWT, Multer, Firebase Admin, Joi, Helmet, CORS, bcryptjs
- Features: CRUD for users/positions/news/events/media, role-targeted push notifications, governorate filtering
- Deployment: .env config, Docker support for client, seed script for initial data

##### Main Components
- Presentation Layer
- Web Client (React SSR + CSR)
- Mobile Client (Flutter)
- API Layer (Node.js/Express Monolith)
- HTTP Router (routes/*.js)
- Controllers (controllers/*.js)
- Middleware (auth.js, error.js, CORS, Helmet)
- Services & Utilities (Joi validation, Multer uploads, Firebase SDK)
- Data Layer
- MongoDB (hosted or local) accessed via Mongoose ODM (models/*.js)
- File Storage (local uploads folder)
- External Services
- Firebase Cloud Messaging (Push Notifications)
- Optional: Nginx as reverse proxy for web client

##### Relationships and Data Flows
- Web & Mobile clients → HTTP(S) → API endpoints (/api/v1/*)
- API middleware applies CORS, auth (JWT), input validation
- Controllers orchestrate business logic and call:
- Mongoose models → MongoDB
- Multer → store files to uploads/
- Firebase Admin SDK → send push notifications
- API → responses (JSON, status codes) → clients
- Database seeding via seed.js
- Deployment:
- Client Docker → static assets served via Nginx
- Backend Node process → listens on PORT
- Mobile app deployed to app stores

##### Architectural Patterns & Principles
- Layered architecture (Presentation → API → Data)
- Separation of concerns (routes vs controllers vs models)
- Stateless RESTful API with JWT auth
- Feature-based modularization in mobile Flutter app
- SSR for web SEO + client hydration
- Centralized error handling & input validation

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Presentation Layer"
        subgraph "Web Client (React SSR + CSR)" 
            SSR["SSR Entry"]:::frontend
            MetaPage["getPageMeta.js"]:::frontend
            MetaNews["getNewsMeta.js"]:::frontend
            ScriptGen["generate-sitemap.js"]:::frontend
            ScriptCron["sitemap-cron.js"]:::frontend
            Assets["Public Assets"]:::frontend
            Source["Source Code"]:::frontend
        end
        subgraph "Mobile Client (Flutter)" 
            MobileCore["Core & DI"]:::frontend
            MobileFeatures["Feature Modules"]:::frontend
            MobileShared["Shared & Localization"]:::frontend
        end
    end

    subgraph "API Monolith (Node.js/Express)" 
        Entry["Entry Point: server.js"]:::backend
        Config["DB Config"]:::backend
        Router["Routes"]:::backend
        Middleware["Auth & Error Middleware"]:::middleware
        Controllers["Controllers"]:::backend
        Models["Data Models"]:::model
        Utilities["Utilities & Services"]:::service
        Seed["Seed Script"]:::backend
        Env["Env Example"]:::backend
        Packages["Dependencies & Scripts"]:::backend
    end

    DB[(MongoDB)]:::database
    FileStore["File Storage (uploads/)"]:::filestore
    FirebaseCloud(("Firebase Cloud Messaging")):::external

    SSR -->|REST/HTTP + JWT| Router
    MobileCore -->|REST/HTTP + JWT| Router
    Router -->|calls controllers| Controllers
    Router -->|intercept| Middleware
    Middleware -->|authorizes| Controllers
    Controllers -->|uses models| Models
    Controllers -->|calls utilities| Utilities
    Controllers -->|file write/read| FileStore
    Controllers -->|push calls| FirebaseCloud
    Models -->|Mongoose queries| DB
    Utilities -->|upload| FileStore
    Utilities -->|push| FirebaseCloud

    click SSR "https://github.com/abdelrahmantarek790/tahyamisrsite/tree/main/client/"
    click MetaPage "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/client/server/getPageMeta.js"
    click MetaNews "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/client/server/getNewsMeta.js"
    click ScriptGen "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/client/scripts/generate-sitemap.js"
    click ScriptCron "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/client/scripts/sitemap-cron.js"
    click Assets "https://github.com/abdelrahmantarek790/tahyamisrsite/tree/main/client/public/"
    click Source "https://github.com/abdelrahmantarek790/tahyamisrsite/tree/main/client/src/"
    click MobileCore "https://github.com/abdelrahmantarek790/tahyamisrsite/tree/main/mobile/lib/core/"
    click MobileFeatures "https://github.com/abdelrahmantarek790/tahyamisrsite/tree/main/mobile/lib/features/"
    click MobileShared "https://github.com/abdelrahmantarek790/tahyamisrsite/tree/main/mobile/lib/shared/"
    click Entry "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/server.js"
    click Config "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/config/database.js"
    click Router "https://github.com/abdelrahmantarek790/tahyamisrsite/tree/main/routes/"
    click Middleware "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/middleware/auth.js"
    click Controllers "https://github.com/abdelrahmantarek790/tahyamisrsite/tree/main/controllers/"
    click Models "https://github.com/abdelrahmantarek790/tahyamisrsite/tree/main/models/"
    click Utilities "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/utils/upload.js"
    click Utilities "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/utils/validation.js"
    click Utilities "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/utils/firebase.js"
    click Utilities "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/utils/email.js"
    click Seed "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/seed.js"
    click Env "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/.env.example"
    click Packages "https://github.com/abdelrahmantarek790/tahyamisrsite/blob/main/package.json"

    classDef frontend fill:#cce5ff,stroke:#004085,color:#004085
    classDef backend fill:#d4edda,stroke:#155724,color:#155724
    classDef middleware fill:#fff3cd,stroke:#856404,color:#856404
    classDef service fill:#e2e3e5,stroke:#6c757d,color:#6c757d
    classDef model fill:#d1ecf1,stroke:#0c5460,color:#0c5460
    classDef database fill:#ffe5b4,stroke:#e0821b,color:#e0821b
    classDef filestore fill:#f0f0f0,stroke:#6c757d,color:#6c757d
    classDef external fill:#e6e6fa,stroke:#800080,color:#800080
```
