# notehive-aust/notehive architecture

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

- Interactive diagram: https://gitdiagram.com/notehive-aust/notehive
- Repository: https://github.com/notehive-aust/notehive

## Overview

NoteHive is a Flutter app for sharing academic materials in course rooms. Students authenticate, create or join rooms, browse and upload resources, and collaborate; room admins and moderators oversee membership, announcements, and resource approval. The README documents the main screens and Firebase helper modules, but no runtime Dart source was sampled, so screen-to-service links are shown as unverified rather than asserted as confirmed calls.

Main entry points: [`lib/Screens`](https://github.com/notehive-aust/notehive/tree/main/lib/Screens) (Sign in and sign up), [`lib/Screens/homeScreen.dart`](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/homeScreen.dart) (My rooms and navigation), [`lib/Screens/resourcesScreen.dart`](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/resourcesScreen.dart) (Browse resources), [`lib/Screens/resourceUpload.dart`](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/resourceUpload.dart) (Upload resources)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["App and identity"]
  node_app_entry["App entry and auth gate<br/>[main.dart]"]
  node_auth_screens["Sign in and sign up"]
  node_auth_ops["Authentication operations<br/>[auth_services.dart]"]
  node_profile["Profile"]
end

subgraph group_rooms["Room collaboration"]
  node_room_home["My rooms and navigation<br/>[homeScreen.dart]"]
  node_room_discovery["Browse and join rooms<br/>[browseRoom.dart]"]
  node_room_create["Create rooms"]
  node_room_view["Room dashboards<br/>[roomScreen.dart]"]
  node_room_search["Search rooms<br/>[SearchRooms.dart]"]
  node_room_membership["Room membership data<br/>[getMyRooms.dart]"]
end

subgraph group_resources["Resource lifecycle"]
  node_resource_browse["Browse resources"]
  node_resource_upload["Upload resources"]
  node_resource_review["Resource approval"]
  node_resource_detail["Resource details"]
  node_resource_data["Room resource queries"]
  node_file_upload["File storage operations"]
end

subgraph group_community["Community management"]
  node_member_admin["Members and moderators<br/>[members.dart]"]
  node_moderator_ops["Moderator management"]
  node_announcements["Announcements"]
  node_notifications["Notifications"]
  node_my_uploads["My uploads<br/>[my_uploads.dart]"]
end

subgraph group_backend["Firebase services"]
  node_firebase_auth{{"Firebase Auth"}}
  node_firestore[("Cloud Firestore")]
  node_storage[("Firebase Storage")]
end

node_student(("Student"))

node_student -->|"opens"| node_app_entry
node_app_entry -.->|"routes to"| node_auth_screens
node_auth_screens -.->|"authenticates with"| node_auth_ops
node_auth_ops -->|"uses"| node_firebase_auth
node_auth_screens -.->|"sets up profile"| node_profile
node_student -->|"views rooms"| node_room_home
node_room_home -.->|"loads memberships"| node_room_membership
node_student -->|"finds rooms"| node_room_discovery
node_student -->|"creates room"| node_room_create
node_room_discovery -.->|"searches"| node_room_search
node_room_home -.->|"opens room"| node_room_view
node_student -->|"browses materials"| node_resource_browse
node_student -->|"uploads material"| node_resource_upload
node_resource_browse -.->|"loads resources"| node_resource_data
node_resource_upload -.->|"stores files"| node_file_upload
node_resource_upload -.->|"submits for approval"| node_resource_review
node_resource_browse -.->|"opens details"| node_resource_detail
node_student -->|"views members"| node_member_admin
node_member_admin -.->|"manages roles"| node_moderator_ops
node_student -->|"views updates"| node_announcements
node_student -->|"views notifications"| node_notifications
node_student -->|"tracks uploads"| node_my_uploads
node_room_membership -->|"reads rooms"| node_firestore
node_resource_data -->|"reads resources"| node_firestore
node_moderator_ops -.->|"manages records"| node_firestore
node_file_upload -->|"stores files"| node_storage

click node_app_entry "https://github.com/notehive-aust/notehive/blob/main/lib/main.dart"
click node_auth_screens "https://github.com/notehive-aust/notehive/tree/main/lib/Screens"
click node_auth_ops "https://github.com/notehive-aust/notehive/blob/main/lib/FirebaseOperations/auth_services.dart"
click node_profile "https://github.com/notehive-aust/notehive/blob/main/lib/Screens/profile_screen.dart"
click node_room_home "https://github.com/notehive-aust/notehive/blob/main/lib/Screens/homeScreen.dart"
click node_room_discovery "https://github.com/notehive-aust/notehive/blob/main/lib/Screens/browseRoom.dart"
click node_room_create "https://github.com/notehive-aust/notehive/blob/main/lib/Screens/create_room_screen.dart"
click node_room_view "https://github.com/notehive-aust/notehive/blob/main/lib/Screens/roomScreen.dart"
click node_room_search "https://github.com/notehive-aust/notehive/blob/main/lib/FirebaseOperations/SearchRooms.dart"
click node_room_membership "https://github.com/notehive-aust/notehive/blob/main/lib/FirebaseOperations/getMyRooms.dart"
click node_resource_browse "https://github.com/notehive-aust/notehive/blob/main/lib/Screens/resourcesScreen.dart"
click node_resource_upload "https://github.com/notehive-aust/notehive/blob/main/lib/Screens/resourceUpload.dart"
click node_resource_review "https://github.com/notehive-aust/notehive/blob/main/lib/Screens/pendingApproval.dart"
click node_resource_detail "https://github.com/notehive-aust/notehive/blob/main/lib/Screens/resourceDetails.dart"
click node_resource_data "https://github.com/notehive-aust/notehive/blob/main/lib/FirebaseOperations/getRoomResources.dart"
click node_file_upload "https://github.com/notehive-aust/notehive/blob/main/lib/FirebaseOperations/firebase_storage_services.dart"
click node_member_admin "https://github.com/notehive-aust/notehive/blob/main/lib/Screens/members.dart"
click node_moderator_ops "https://github.com/notehive-aust/notehive/blob/main/lib/FirebaseOperations/manageModerators.dart"
click node_announcements "https://github.com/notehive-aust/notehive/blob/main/lib/Screens/room_announcement_page.dart"
click node_notifications "https://github.com/notehive-aust/notehive/blob/main/lib/Screens/notifications_screen.dart"
click node_my_uploads "https://github.com/notehive-aust/notehive/blob/main/lib/Screens/my_uploads.dart"

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_app_entry,node_auth_screens,node_auth_ops,node_profile toneBlue
class node_room_home,node_room_discovery,node_room_create,node_room_view,node_room_search,node_room_membership toneAmber
class node_resource_browse,node_resource_upload,node_resource_review,node_resource_detail,node_resource_data,node_file_upload toneMint
class node_member_admin,node_moderator_ops,node_announcements,node_notifications,node_my_uploads toneRose
class node_firebase_auth,node_firestore,node_storage,node_student toneIndigo
```

## Components

### App and identity

- [App entry and auth gate](https://github.com/notehive-aust/notehive/blob/main/lib/main.dart): `lib/main.dart`
- [Sign in and sign up](https://github.com/notehive-aust/notehive/tree/main/lib/Screens): `lib/Screens`
- [Authentication operations](https://github.com/notehive-aust/notehive/blob/main/lib/FirebaseOperations/auth_services.dart): `lib/FirebaseOperations/auth_services.dart`
- [Profile](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/profile_screen.dart): `lib/Screens/profile_screen.dart`

### Room collaboration

- [My rooms and navigation](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/homeScreen.dart): `lib/Screens/homeScreen.dart`
- [Browse and join rooms](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/browseRoom.dart): `lib/Screens/browseRoom.dart`
- [Create rooms](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/create_room_screen.dart): `lib/Screens/create_room_screen.dart`
- [Room dashboards](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/roomScreen.dart): `lib/Screens/roomScreen.dart`
- [Search rooms](https://github.com/notehive-aust/notehive/blob/main/lib/FirebaseOperations/SearchRooms.dart): `lib/FirebaseOperations/SearchRooms.dart`
- [Room membership data](https://github.com/notehive-aust/notehive/blob/main/lib/FirebaseOperations/getMyRooms.dart): `lib/FirebaseOperations/getMyRooms.dart`

### Resource lifecycle

- [Browse resources](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/resourcesScreen.dart): `lib/Screens/resourcesScreen.dart`
- [Upload resources](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/resourceUpload.dart): `lib/Screens/resourceUpload.dart`
- [Resource approval](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/pendingApproval.dart): `lib/Screens/pendingApproval.dart`
- [Resource details](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/resourceDetails.dart): `lib/Screens/resourceDetails.dart`
- [Room resource queries](https://github.com/notehive-aust/notehive/blob/main/lib/FirebaseOperations/getRoomResources.dart): `lib/FirebaseOperations/getRoomResources.dart`
- [File storage operations](https://github.com/notehive-aust/notehive/blob/main/lib/FirebaseOperations/firebase_storage_services.dart): `lib/FirebaseOperations/firebase_storage_services.dart`

### Community management

- [Members and moderators](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/members.dart): `lib/Screens/members.dart`
- [Moderator management](https://github.com/notehive-aust/notehive/blob/main/lib/FirebaseOperations/manageModerators.dart): `lib/FirebaseOperations/manageModerators.dart`
- [Announcements](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/room_announcement_page.dart): `lib/Screens/room_announcement_page.dart`
- [Notifications](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/notifications_screen.dart): `lib/Screens/notifications_screen.dart`
- [My uploads](https://github.com/notehive-aust/notehive/blob/main/lib/Screens/my_uploads.dart): `lib/Screens/my_uploads.dart`

### Firebase services

- **Firebase Auth**
- **Cloud Firestore**
- **Firebase Storage**

### Other components

- **Student**

## Connections

- Student → App entry and auth gate: opens (evidence: `README.md`)
- App entry and auth gate → Sign in and sign up: routes to
- Sign in and sign up → Authentication operations: authenticates with
- Authentication operations → Firebase Auth: uses (evidence: `README.md`)
- Sign in and sign up → Profile: sets up profile
- Student → My rooms and navigation: views rooms (evidence: `README.md`)
- My rooms and navigation → Room membership data: loads memberships
- Student → Browse and join rooms: finds rooms (evidence: `README.md`)
- Student → Create rooms: creates room (evidence: `README.md`)
- Browse and join rooms → Search rooms: searches
- My rooms and navigation → Room dashboards: opens room
- Student → Browse resources: browses materials (evidence: `README.md`)
- Student → Upload resources: uploads material (evidence: `README.md`)
- Browse resources → Room resource queries: loads resources
- Upload resources → File storage operations: stores files
- Upload resources → Resource approval: submits for approval
- Browse resources → Resource details: opens details
- Student → Members and moderators: views members (evidence: `README.md`)
- Members and moderators → Moderator management: manages roles
- Student → Announcements: views updates (evidence: `README.md`)
- Student → Notifications: views notifications (evidence: `README.md`)
- Student → My uploads: tracks uploads (evidence: `README.md`)
- Room membership data → Cloud Firestore: reads rooms (evidence: `README.md`)
- Room resource queries → Cloud Firestore: reads resources (evidence: `README.md`)
- Moderator management → Cloud Firestore: manages records
- File storage operations → Firebase Storage: stores files (evidence: `README.md`)
