# ivennjy/supershapeadmin-cap architecture

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

- Interactive diagram: https://gitdiagram.com/ivennjy/supershapeadmin-cap
- Repository: https://github.com/ivennjy/supershapeadmin-cap

## Overview

##### Project Type and Purpose
- This is a full-stack, serverless admin dashboard (React/Vite frontend + Netlify Functions + Firebase backend).
- Purpose: Allow Admin and Superadmin users to manage classes, users, announcements, credits, etc.

##### File Structure
- Top-level folders:
– backend/ (firebaseConfig.js)
– netlify/functions/ (createUser.js, notifyWaitingList.js)
– public/ & image samples (static assets)
– src/ (React code: App.jsx, components/, pages/, utils/)
- Config/build files:
– vite.config.js, package.json, .env.sample
- Deployment:
– Hosted on Netlify, uses serverless functions + static build

##### Architecture Overview
Components:
A. Client (React SPA)
- Runs in user’s browser
- Built with Vite, React, TailwindCSS
- Routes under src/pages (Admin vs Superadmin sections)
B. CDN & Static Hosting
- Netlify serves the built bundle (dist/) via a CDN
C. Serverless API Layer
- Netlify Functions:
- createUser.js – provisions new users in Firebase Auth/Firestore
- notifyWaitingList.js – sends notifications via Firebase (e.g., Firestore triggers or FCM)
D. Firebase Services
- Authentication (Auth Domain)
- Firestore Database (Projects, Users, Classes, Announcements, Credits)
- Cloud Storage (if storing files)
- Analytics / Messaging (optional via measurement ID)

##### Relationships & Data Flows
1. User opens browser → requests SPA from Netlify CDN.
2. React App initializes ← Firebase config (env vars loaded at runtime).
3. User logs in via Firebase Auth SDK → tokens returned.
4. ProtectedRoutes (src/components/protectedRoute.jsx) guard admin pages.
5. For CRUD operations:
- Option A: Direct Firestore calls from React (SDK).
- Option B: Invoke Netlify Function → function code uses firebaseConfig to operate on Firestore/Auth.
6. notifyWaitingList.js may be triggered by either API call or Firestore trigger (depending on implementation), sending emails or FCM notifications.

##### Architectural Patterns & Principles
- Client-side MVC-esque routing:
– src/pages for views, src/components for reusable widgets
- Serverless micro-endpoints:
– Each function implements a single responsibility (createUser, notifyWaitingList)
- Environment-based configuration:
– VITE_ prefixed vars injected at build time

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User Layer
    subgraph "End User (Browser)"
        direction TB
        Browser["User's Browser"]:::external
    end

    %% CDN & Hosting Layer
    subgraph "CDN & Static Hosting (Netlify)"
        direction TB
        CDN["Netlify CDN"]:::cdn
        Static["index.html & JS Bundle"]:::frontend
    end

    %% Client Layer
    subgraph "Client (React SPA)" 
        direction TB
        style ClientLayer stroke-dasharray: 5 5
        ClientLayer(("Environment Boundary (.env)")):::boundary

        subgraph "SPA Core"
            direction TB
            MainEntry["main.jsx"]:::frontend
            AppRoot["App.jsx"]:::frontend
            Styling["index.css"]:::frontend
        end

        subgraph "Components"
            direction TB
            Confirm["ConfirmPopup.jsx"]:::frontend
            ViewMore["ViewMoreModal.jsx"]:::frontend
            ProtectedRoute["protectedRoute.jsx"]:::frontend
            Toast["toast.jsx"]:::frontend
        end

        subgraph "Pages"
            direction TB
            Common["src/pages"]:::frontend
            Landing["index.jsx"]:::frontend
            ErrorPage["ErrorPage.jsx"]:::frontend

            subgraph "Admin Section"
                direction TB
                ADash["Dashboard.jsx"]:::frontend
                AClasses["Classes.jsx"]:::frontend
                AddClass["AddClasses.jsx"]:::frontend
                ClassDetails["ClassDetails.jsx"]:::frontend
                AUsers["Users.jsx"]:::frontend
                AddUser["AddUser.jsx"]:::frontend
                UserDetails["UserDetails.jsx"]:::frontend
                AssignStudent["AssignStudent.jsx"]:::frontend
                Announcement["Announcement.jsx"]:::frontend
                NewAnnouncement["NewAnnouncemnet.jsx"]:::frontend
                Credits["Credits.jsx"]:::frontend
                CreditDetails["CreditDetails.jsx"]:::frontend
                Packages["Packages.jsx"]:::frontend
                SettingsA["Settings.jsx"]:::frontend
                NavbarA["Navbar.jsx"]:::frontend
            end

            subgraph "Superadmin Section"
                direction TB
                SADash["Dashboard.jsx"]:::frontend
                SAUsers["Users.jsx"]:::frontend
                SAUserDetails["UserDetails.jsx"]:::frontend
                SAAnnouncement["Announcement.jsx"]:::frontend
                AddSAAnnouncement["AddAnnouncement.jsx"]:::frontend
                SettingsSA["Settings.jsx"]:::frontend
                NavbarSA["Navbar.jsx"]:::frontend
            end
        end

        Utils["notifyWaitingList.js"]:::frontend
    end

    %% Serverless Functions Layer
    subgraph "Serverless API Layer (Netlify Functions)"
        direction TB
        CreateUser["createUser.js"]:::function
        NotifyWaiting["notifyWaitingList.js"]:::function
    end

    %% Firebase Services Layer
    subgraph "Firebase Services"
        direction TB
        Auth["Authentication"]:::db
        Firestore["Firestore Database"]:::db
        Storage["Cloud Storage"]:::db
        Analytics["Analytics/Messaging"]:::db
    end

    %% Connections
    Browser -->|"GET index.html, JS Bundle"| CDN
    CDN --> Static
    Static -->|"Loads SPA"| MainEntry
    MainEntry --> AppRoot
    AppRoot --> Styling

    AppRoot --> ProtectedRoute
    AppRoot --> Confirm
    AppRoot --> ViewMore
    AppRoot --> Toast

    AppRoot --> Landing
    AppRoot --> ErrorPage
    Landing --> Common
    ErrorPage --> Common

    AppRoot --> ADash
    AppRoot --> SADash

    AppRoot --> Utils

    AppRoot -->|"Firebase Auth SDK"| Auth
    AppRoot -->|"Firestore SDK"| Firestore

    AppRoot -->|"HTTP POST /createUser"| CreateUser
    AppRoot -->|"HTTP POST /notifyWaitingList"| NotifyWaiting
    CreateUser -->|"Admin SDK"| Auth
    CreateUser --> Firestore
    NotifyWaiting --> Firestore
    NotifyWaiting --> Analytics

    %% Click Events
    click ClientLayer "https://github.com/ivennjy/supershapeadmin-cap/blob/main/.env.sample"
    click MainEntry "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/main.jsx"
    click AppRoot "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/App.jsx"
    click Styling "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/index.css"
    click Confirm "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/components/ConfirmPopup.jsx"
    click ViewMore "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/components/ViewMoreModal.jsx"
    click ProtectedRoute "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/components/protectedRoute.jsx"
    click Toast "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/components/toast.jsx"
    click Landing "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/index.jsx"
    click ErrorPage "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/ErrorPage.jsx"
    click ADash "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/Dashboard.jsx"
    click AClasses "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/Classes.jsx"
    click AddClass "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/AddClasses.jsx"
    click ClassDetails "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/ClassDetails.jsx"
    click AUsers "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/Users.jsx"
    click AddUser "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/AddUser.jsx"
    click UserDetails "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/UserDetails.jsx"
    click AssignStudent "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/AssignStudent.jsx"
    click Announcement "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/Announcement.jsx"
    click NewAnnouncement "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/NewAnnouncemnet.jsx"
    click Credits "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/Credits.jsx"
    click CreditDetails "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/CreditDetails.jsx"
    click Packages "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/Packages.jsx"
    click SettingsA "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/Settings.jsx"
    click NavbarA "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/admin/Navbar.jsx"
    click SADash "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/superadmin/Dashboard.jsx"
    click SAUsers "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/superadmin/Users.jsx"
    click SAUserDetails "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/superadmin/UserDetails.jsx"
    click SAAnnouncement "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/superadmin/Announcement.jsx"
    click AddSAAnnouncement "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/superadmin/AddAnnouncement.jsx"
    click SettingsSA "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/superadmin/Settings.jsx"
    click NavbarSA "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/pages/superadmin/Navbar.jsx"
    click Utils "https://github.com/ivennjy/supershapeadmin-cap/blob/main/src/utils/notifyWaitingList.js"
    click CreateUser "https://github.com/ivennjy/supershapeadmin-cap/blob/main/netlify/functions/createUser.js"
    click NotifyWaiting "https://github.com/ivennjy/supershapeadmin-cap/blob/main/netlify/functions/notifyWaitingList.js"
    click Auth "https://github.com/ivennjy/supershapeadmin-cap/blob/main/backend/firebaseConfig.js"
    click Firestore "https://github.com/ivennjy/supershapeadmin-cap/blob/main/backend/firebaseConfig.js"
    click Storage "https://github.com/ivennjy/supershapeadmin-cap/blob/main/backend/firebaseConfig.js"
    click Analytics "https://github.com/ivennjy/supershapeadmin-cap/blob/main/backend/firebaseConfig.js"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#0275d8,color:#000
    classDef function fill:#FFE0B2,stroke:#f57c00,color:#000
    classDef db fill:#D0FFD8,stroke:#28a745,color:#000
    classDef external fill:#F2F2F2,stroke:#6c757d,color:#000
    classDef cdn fill:#E0F7FA,stroke:#0097a7,color:#000
    classDef boundary stroke-dasharray: 5 5,color:#000
```
