# akashcyber02/mits-club-hub architecture

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

- Interactive diagram: https://gitdiagram.com/akashcyber02/mits-club-hub
- Repository: https://github.com/akashcyber02/mits-club-hub

## Overview

MITS Club Hub is a campus-club discovery and management portal. Students sign in, find approved clubs, and apply to join; faculty review club submissions, while presidents manage club information and membership. The main application logic is concentrated in app.js, with Firebase providing authentication and live data storage. The README documents the broader workflows and integrations; sampled app.js excerpts confirm some Firestore operations, but do not expose every feature’s implementation details.

Main entry points: [`index.html`](https://github.com/akashcyber02/mits-club-hub/blob/main/index.html) (Club Hub UI), [`app.js`](https://github.com/akashcyber02/mits-club-hub/blob/main/app.js) (Google Sign-In), [`firestore.rules`](https://github.com/akashcyber02/mits-club-hub/blob/main/firestore.rules) (Firestore Rules), [`firebase-config.js`](https://github.com/akashcyber02/mits-club-hub/blob/main/firebase-config.js) (Firebase Setup)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_access["Access &amp; Security"]
  node_auth["Google Sign-In<br/>[app.js]"]
  node_rbac["Role Access<br/>[app.js]"]
  node_rules["Firestore Rules<br/>[firestore.rules]"]
end

subgraph group_discovery["Club Discovery"]
  node_portal["Club Hub UI<br/>[index.html]"]
  node_club_search["Search &amp; Filters<br/>[app.js]"]
  node_club_details["Club Details<br/>[app.js]"]
end

subgraph group_governance["Club Governance"]
  node_applications["Membership Applications<br/>[app.js]"]
  node_club_registration["Club Registration<br/>[app.js]"]
  node_faculty_review["Faculty Approval<br/>[app.js]"]
  node_president_tools["President Management<br/>[app.js]"]
  node_leadership["Leadership Handover<br/>[app.js]"]
end

subgraph group_platform["Cloud Platform"]
  node_realtime["Live Updates<br/>[app.js]"]
  node_firebase_config["Firebase Setup<br/>[firebase-config.js]"]
  node_firestore[("Firestore")]
end

node_students(("Students"))
node_faculty(("Faculty Mentors"))
node_presidents(("Club Presidents"))
node_google{{"Google Authentication"}}
node_whatsapp{{"WhatsApp Groups"}}

node_students -->|"browse"| node_portal
node_faculty -->|"review"| node_portal
node_presidents -->|"manage"| node_portal
node_portal -->|"signs in"| node_auth
node_auth -->|"authenticates"| node_google
node_auth -->|"checks roles"| node_rbac
node_rbac -->|"enforces access"| node_rules
node_students -->|"searches"| node_club_search
node_club_search -->|"opens club"| node_club_details
node_club_details -->|"joins group"| node_whatsapp
node_students -->|"submits club"| node_club_registration
node_club_registration -->|"creates pending club"| node_firestore
node_faculty -->|"reviews submission"| node_faculty_review
node_faculty_review -->|"updates approval"| node_firestore
node_students -->|"applies"| node_applications
node_applications -->|"stores applications"| node_firestore
node_presidents -->|"updates club"| node_president_tools
node_president_tools -->|"updates club data"| node_firestore
node_presidents -->|"nominates successor"| node_leadership
node_leadership -->|"records handover"| node_firestore
node_firebase_config -->|"initializes client"| node_firestore
node_realtime -->|"listens for changes"| node_firestore
node_firestore -->|"updates views"| node_portal
node_rules -->|"restricts access"| node_firestore

click node_portal "https://github.com/akashcyber02/mits-club-hub/blob/main/index.html"
click node_auth "https://github.com/akashcyber02/mits-club-hub/blob/main/app.js"
click node_rbac "https://github.com/akashcyber02/mits-club-hub/blob/main/app.js"
click node_club_search "https://github.com/akashcyber02/mits-club-hub/blob/main/app.js"
click node_club_details "https://github.com/akashcyber02/mits-club-hub/blob/main/app.js"
click node_applications "https://github.com/akashcyber02/mits-club-hub/blob/main/app.js"
click node_club_registration "https://github.com/akashcyber02/mits-club-hub/blob/main/app.js"
click node_faculty_review "https://github.com/akashcyber02/mits-club-hub/blob/main/app.js"
click node_president_tools "https://github.com/akashcyber02/mits-club-hub/blob/main/app.js"
click node_leadership "https://github.com/akashcyber02/mits-club-hub/blob/main/app.js"
click node_realtime "https://github.com/akashcyber02/mits-club-hub/blob/main/app.js"
click node_firebase_config "https://github.com/akashcyber02/mits-club-hub/blob/main/firebase-config.js"
click node_rules "https://github.com/akashcyber02/mits-club-hub/blob/main/firestore.rules"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_auth,node_rbac,node_rules toneBlue
class node_portal,node_club_search,node_club_details toneAmber
class node_applications,node_club_registration,node_faculty_review,node_president_tools,node_leadership toneMint
class node_realtime,node_firebase_config,node_firestore toneRose
class node_students,node_faculty,node_presidents,node_google,node_whatsapp toneIndigo
```

## Components

### Access & Security

- [Google Sign-In](https://github.com/akashcyber02/mits-club-hub/blob/main/app.js): `app.js`
- [Role Access](https://github.com/akashcyber02/mits-club-hub/blob/main/app.js): `app.js`
- [Firestore Rules](https://github.com/akashcyber02/mits-club-hub/blob/main/firestore.rules): `firestore.rules`

### Club Discovery

- [Club Hub UI](https://github.com/akashcyber02/mits-club-hub/blob/main/index.html): `index.html`
- [Search & Filters](https://github.com/akashcyber02/mits-club-hub/blob/main/app.js): `app.js`
- [Club Details](https://github.com/akashcyber02/mits-club-hub/blob/main/app.js): `app.js`

### Club Governance

- [Membership Applications](https://github.com/akashcyber02/mits-club-hub/blob/main/app.js): `app.js`
- [Club Registration](https://github.com/akashcyber02/mits-club-hub/blob/main/app.js): `app.js`
- [Faculty Approval](https://github.com/akashcyber02/mits-club-hub/blob/main/app.js): `app.js`
- [President Management](https://github.com/akashcyber02/mits-club-hub/blob/main/app.js): `app.js`
- [Leadership Handover](https://github.com/akashcyber02/mits-club-hub/blob/main/app.js): `app.js`

### Cloud Platform

- [Live Updates](https://github.com/akashcyber02/mits-club-hub/blob/main/app.js): `app.js`
- [Firebase Setup](https://github.com/akashcyber02/mits-club-hub/blob/main/firebase-config.js): `firebase-config.js`
- **Firestore**

### Other components

- **Students**
- **Faculty Mentors**
- **Club Presidents**
- **Google Authentication**
- **WhatsApp Groups**

## Connections

- Students → Club Hub UI: browse (evidence: `README.md`)
- Faculty Mentors → Club Hub UI: review (evidence: `README.md`)
- Club Presidents → Club Hub UI: manage (evidence: `README.md`)
- Club Hub UI → Google Sign-In: signs in (evidence: `README.md`)
- Google Sign-In → Google Authentication: authenticates (evidence: `README.md`)
- Google Sign-In → Role Access: checks roles (evidence: `README.md`)
- Role Access → Firestore Rules: enforces access (evidence: `README.md`)
- Students → Search & Filters: searches (evidence: `README.md`)
- Search & Filters → Club Details: opens club (evidence: `README.md`)
- Club Details → WhatsApp Groups: joins group (evidence: `README.md`)
- Students → Club Registration: submits club (evidence: `README.md`)
- Club Registration → Firestore: creates pending club (evidence: `README.md`)
- Faculty Mentors → Faculty Approval: reviews submission (evidence: `README.md`)
- Faculty Approval → Firestore: updates approval (evidence: `README.md`)
- Students → Membership Applications: applies (evidence: `README.md`)
- Membership Applications → Firestore: stores applications (evidence: `README.md`)
- Club Presidents → President Management: updates club (evidence: `README.md`)
- President Management → Firestore: updates club data (evidence: `README.md`)
- Club Presidents → Leadership Handover: nominates successor (evidence: `README.md`)
- Leadership Handover → Firestore: records handover (evidence: `app.js`)
- Firebase Setup → Firestore: initializes client (evidence: `firebase-config.js`)
- Live Updates → Firestore: listens for changes (evidence: `README.md`)
- Firestore → Club Hub UI: updates views (evidence: `README.md`)
- Firestore Rules → Firestore: restricts access (evidence: `README.md`)
