# zedsalim/csbouira architecture

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

- Interactive diagram: https://gitdiagram.com/zedsalim/csbouira
- Repository: https://github.com/zedsalim/csbouira

## Overview

CS Bouira is a browser-based university study hub: students browse study materials by year and module, search and open resources, and can upload files. Its other major capabilities include favorites, PDF viewing, document scanning, a grade calculator, contact, theme and dhikr features. The graph reflects documented API-backed resources and sampled module dependencies; some main-page wiring and API request flows are not visible in the excerpts, so those links are left unverified or omitted.

Main entry points: [`src/main.js`](https://github.com/zedsalim/csbouira/blob/master/src/main.js) (Study Hub UI), [`src/modules/upload.js`](https://github.com/zedsalim/csbouira/blob/master/src/modules/upload.js) (File Upload), [`src/config.js`](https://github.com/zedsalim/csbouira/blob/master/src/config.js) (App Config), [`src/utils/helpers.js`](https://github.com/zedsalim/csbouira/blob/master/src/utils/helpers.js) (Shared Helpers)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_study["Study Hub"]
  node_app["Study Hub UI<br/>[main.js]"]
  node_search["Resource Search<br/>[search.js]"]
  node_favorites[("Favorites<br/>[favorites.js]")]
  node_pdf["PDF Viewer<br/>[pdfViewer.js]"]
  node_loader["Resource Loader<br/>[loader.js]"]
end

subgraph group_contribution["Student Contributions"]
  node_upload["File Upload<br/>[upload.js]"]
  node_scanner["Document Scanner<br/>[scanner.js]"]
  node_contact["Contact Form<br/>[contact.js]"]
end

subgraph group_tools["Student Tools"]
  node_moadaly["Grade Calculator<br/>[moadaly.js]"]
  node_gradefiles["Grade Templates"]
  node_dhikr["Dhikr Counter<br/>[dhikr.js]"]
  node_theme["Theme Selector<br/>[theme.js]"]
  node_celebration["Celebrations<br/>[celebration.js]"]
end

subgraph group_shared["Shared Services"]
  node_config["App Config<br/>[config.js]"]
  node_helpers["Shared Helpers<br/>[helpers.js]"]
end

node_student(("Student"))
node_api{{"CSBouira API"}}
node_uploadservice{{"Upload Service"}}
node_contactservice{{"Contact Service"}}

node_student -->|"uses"| node_app
node_app -->|"imports"| node_config
node_app -->|"imports"| node_search
node_app -->|"imports"| node_upload
node_app -->|"imports"| node_scanner
node_app -->|"imports"| node_pdf
node_app -->|"toggles"| node_favorites
node_app -->|"uses"| node_helpers
node_app -->|"imports"| node_loader
node_app -->|"imports"| node_contact
node_app -->|"imports"| node_dhikr
node_app -->|"imports"| node_theme
node_app -->|"imports"| node_moadaly
node_app -.->|"loads resources"| node_api
node_search -->|"reads"| node_config
node_search -->|"uses"| node_helpers
node_favorites -->|"reads key"| node_config
node_favorites -->|"uses"| node_helpers
node_upload -->|"reads endpoint"| node_config
node_upload -->|"uses"| node_helpers
node_upload -->|"registers callback"| node_scanner
node_upload -->|"opens preview"| node_pdf
node_upload -->|"triggers"| node_celebration
node_upload -->|"posts files"| node_uploadservice
node_scanner -->|"uses transforms"| node_helpers
node_contact -->|"reads endpoint"| node_config
node_contact -->|"validates email"| node_helpers
node_contact -->|"posts message"| node_contactservice
node_moadaly -->|"reads settings"| node_config
node_moadaly -->|"loads templates"| node_gradefiles
node_moadaly -->|"uses helpers"| node_helpers
node_moadaly -->|"triggers"| node_celebration
node_dhikr -->|"reads sayings"| node_config
node_theme -->|"reads themes"| node_config

click node_app "https://github.com/zedsalim/csbouira/blob/master/src/main.js"
click node_config "https://github.com/zedsalim/csbouira/blob/master/src/config.js"
click node_search "https://github.com/zedsalim/csbouira/blob/master/src/modules/search.js"
click node_favorites "https://github.com/zedsalim/csbouira/blob/master/src/modules/favorites.js"
click node_pdf "https://github.com/zedsalim/csbouira/blob/master/src/modules/pdfViewer.js"
click node_loader "https://github.com/zedsalim/csbouira/blob/master/src/modules/loader.js"
click node_upload "https://github.com/zedsalim/csbouira/blob/master/src/modules/upload.js"
click node_scanner "https://github.com/zedsalim/csbouira/blob/master/src/modules/scanner.js"
click node_contact "https://github.com/zedsalim/csbouira/blob/master/src/modules/contact.js"
click node_moadaly "https://github.com/zedsalim/csbouira/blob/master/src/modules/moadaly.js"
click node_gradefiles "https://github.com/zedsalim/csbouira/tree/master/src/data/moadaly"
click node_dhikr "https://github.com/zedsalim/csbouira/blob/master/src/modules/dhikr.js"
click node_theme "https://github.com/zedsalim/csbouira/blob/master/src/modules/theme.js"
click node_celebration "https://github.com/zedsalim/csbouira/blob/master/src/modules/celebration.js"
click node_helpers "https://github.com/zedsalim/csbouira/blob/master/src/utils/helpers.js"

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,node_search,node_favorites,node_pdf,node_loader toneBlue
class node_upload,node_scanner,node_contact toneAmber
class node_moadaly,node_gradefiles,node_dhikr,node_theme,node_celebration,node_api toneMint
class node_config,node_helpers toneRose
class node_student,node_uploadservice,node_contactservice toneIndigo
```

## Components

### Study Hub

- [Study Hub UI](https://github.com/zedsalim/csbouira/blob/master/src/main.js): `src/main.js`
- [Resource Search](https://github.com/zedsalim/csbouira/blob/master/src/modules/search.js): `src/modules/search.js`
- [Favorites](https://github.com/zedsalim/csbouira/blob/master/src/modules/favorites.js): `src/modules/favorites.js`
- [PDF Viewer](https://github.com/zedsalim/csbouira/blob/master/src/modules/pdfViewer.js): `src/modules/pdfViewer.js`
- [Resource Loader](https://github.com/zedsalim/csbouira/blob/master/src/modules/loader.js): `src/modules/loader.js`

### Student Contributions

- [File Upload](https://github.com/zedsalim/csbouira/blob/master/src/modules/upload.js): `src/modules/upload.js`
- [Document Scanner](https://github.com/zedsalim/csbouira/blob/master/src/modules/scanner.js): `src/modules/scanner.js`
- [Contact Form](https://github.com/zedsalim/csbouira/blob/master/src/modules/contact.js): `src/modules/contact.js`

### Student Tools

- [Grade Calculator](https://github.com/zedsalim/csbouira/blob/master/src/modules/moadaly.js): `src/modules/moadaly.js`
- [Grade Templates](https://github.com/zedsalim/csbouira/tree/master/src/data/moadaly): `src/data/moadaly`
- [Dhikr Counter](https://github.com/zedsalim/csbouira/blob/master/src/modules/dhikr.js): `src/modules/dhikr.js`
- [Theme Selector](https://github.com/zedsalim/csbouira/blob/master/src/modules/theme.js): `src/modules/theme.js`
- [Celebrations](https://github.com/zedsalim/csbouira/blob/master/src/modules/celebration.js): `src/modules/celebration.js`

### Shared Services

- [App Config](https://github.com/zedsalim/csbouira/blob/master/src/config.js): `src/config.js`
- [Shared Helpers](https://github.com/zedsalim/csbouira/blob/master/src/utils/helpers.js): `src/utils/helpers.js`

### Other components

- **Student**
- **CSBouira API**
- **Upload Service**
- **Contact Service**

## Connections

- Student → Study Hub UI: uses (evidence: `README.md`)
- Study Hub UI → App Config: imports (evidence: `src/main.js`)
- Study Hub UI → Resource Search: imports (evidence: `src/main.js`)
- Study Hub UI → File Upload: imports (evidence: `src/main.js`)
- Study Hub UI → Document Scanner: imports (evidence: `src/main.js`)
- Study Hub UI → PDF Viewer: imports (evidence: `src/main.js`)
- Study Hub UI → Favorites: toggles (evidence: `src/main.js`)
- Study Hub UI → Shared Helpers: uses (evidence: `src/main.js`)
- Study Hub UI → Resource Loader: imports (evidence: `src/main.js`)
- Study Hub UI → Contact Form: imports (evidence: `src/main.js`)
- Study Hub UI → Dhikr Counter: imports (evidence: `src/main.js`)
- Study Hub UI → Theme Selector: imports (evidence: `src/main.js`)
- Study Hub UI → Grade Calculator: imports (evidence: `src/main.js`)
- Study Hub UI → CSBouira API: loads resources
- Resource Search → App Config: reads (evidence: `src/modules/search.js`)
- Resource Search → Shared Helpers: uses (evidence: `src/modules/search.js`)
- Favorites → App Config: reads key (evidence: `src/modules/favorites.js`)
- Favorites → Shared Helpers: uses (evidence: `src/modules/favorites.js`)
- File Upload → App Config: reads endpoint (evidence: `src/modules/upload.js`)
- File Upload → Shared Helpers: uses (evidence: `src/modules/upload.js`)
- File Upload → Document Scanner: registers callback (evidence: `src/modules/upload.js`)
- File Upload → PDF Viewer: opens preview (evidence: `src/modules/upload.js`)
- File Upload → Celebrations: triggers (evidence: `src/modules/upload.js`)
- File Upload → Upload Service: posts files (evidence: `src/modules/upload.js`)
- Document Scanner → Shared Helpers: uses transforms (evidence: `src/modules/scanner.js`)
- Contact Form → App Config: reads endpoint (evidence: `src/modules/contact.js`)
- Contact Form → Shared Helpers: validates email (evidence: `src/modules/contact.js`)
- Contact Form → Contact Service: posts message (evidence: `src/modules/contact.js`)
- Grade Calculator → App Config: reads settings (evidence: `src/modules/moadaly.js`)
- Grade Calculator → Grade Templates: loads templates (evidence: `src/modules/moadaly.js`)
- Grade Calculator → Shared Helpers: uses helpers (evidence: `src/modules/moadaly.js`)
- Grade Calculator → Celebrations: triggers (evidence: `src/modules/moadaly.js`)
- Dhikr Counter → App Config: reads sayings (evidence: `src/modules/dhikr.js`)
- Theme Selector → App Config: reads themes (evidence: `src/modules/theme.js`)
