# bushra-mustafa/methaq architecture

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

- Interactive diagram: https://gitdiagram.com/bushra-mustafa/methaq
- Repository: https://github.com/bushra-mustafa/methaq

## Overview

Methaq is a digital-invitation platform. Its main workflow takes an event owner from creating an event through designing and preparing an invitation, submitting a bank-transfer receipt for administrative review, and publishing a guest-facing invitation; guests can then RSVP. The README also documents template browsing and management, proposal drafts, support, account administration, and WhatsApp messaging. Edges below follow the supplied route excerpt, source references, and README; unsampled domain internals are represented by their exact enclosing directories.

Main entry points: [`app/Http/Controllers/App`](https://github.com/bushra-mustafa/methaq/tree/main/app/Http/Controllers/App) (Event controllers), [`app/Domains/Events/Models/Event.php`](https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Events/Models/Event.php) (Event records), [`app/Domains/Users/Actions/ProcessCloudMsgWebhookAction.php`](https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Users/Actions/ProcessCloudMsgWebhookAction.php) (WhatsApp messaging), [`app/Domains/Events`](https://github.com/bushra-mustafa/methaq/tree/main/app/Domains/Events) (Event lifecycle)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_experience["Web Experience"]
  node_public["Public site"]
  node_app_routes["App routes<br/>[app.php]"]
  node_event_http["Event controllers"]
  node_admin["Filament admin"]
end

subgraph group_events["Events &amp; Publishing"]
  node_event_domain["Event lifecycle"]
  node_event_store[("Event records<br/>[Event.php]")]
  node_invitation["Guest invitation"]
end

subgraph group_studio["Invitation Studio"]
  node_editor_ui["Design editor"]
  node_editor_save["Design save client"]
  node_design_model[("Design documents<br/>[EventDesign.php]")]
  node_templates[("Template library<br/>[Template.php]")]
  node_proposals["Ivory proposals"]
end

subgraph group_commerce["Payments &amp; RSVP"]
  node_payments["Manual payments"]
  node_orders[("Orders<br/>[Order.php]")]
  node_rsvp["Guest responses"]
  node_rsvp_store[("RSVP records<br/>[Rsvp.php]")]
end

subgraph group_accounts["Accounts &amp; Messaging"]
  node_users[("Accounts &amp; roles<br/>[User.php]")]
  node_support["Customer support"]
  node_whatsapp["WhatsApp messaging"]
end

node_owner(("Event owner"))
node_guest(("Invitation guest"))
node_cloudmsg{{"CloudMsg provider"}}

node_owner -.->|"browses templates"| node_public
node_owner -->|"uses app"| node_app_routes
node_app_routes -->|"routes requests"| node_event_http
node_event_http -.->|"runs actions"| node_event_domain
node_event_domain -.->|"reads and writes"| node_event_store
node_event_store -->|"has design"| node_design_model
node_event_store -->|"uses template"| node_templates
node_event_http -.->|"renders editor"| node_editor_ui
node_editor_ui -.->|"saves design"| node_editor_save
node_editor_save -.->|"submits document"| node_design_model
node_event_http -.->|"handles payment"| node_payments
node_payments -.->|"records payment"| node_orders
node_admin -.->|"reviews receipt"| node_orders
node_event_http -.->|"publishes invitation"| node_event_domain
node_guest -->|"opens link"| node_invitation
node_invitation -->|"loads published event"| node_event_store
node_guest -.->|"submits response"| node_rsvp
node_rsvp -.->|"stores response"| node_rsvp_store
node_event_http -->|"exports responses"| node_rsvp
node_owner -.->|"edits proposal"| node_proposals
node_owner -.->|"contacts support"| node_support
node_owner -.->|"requests publish"| node_whatsapp
node_cloudmsg -.->|"sends webhook"| node_whatsapp
node_whatsapp -->|"requests publish"| node_event_domain
node_whatsapp -.->|"queues replies"| node_cloudmsg
node_owner -.->|"manages account"| node_users
node_admin -.->|"manages library"| node_templates

click node_public "https://github.com/bushra-mustafa/methaq/tree/main/resources/js/Components/Public"
click node_app_routes "https://github.com/bushra-mustafa/methaq/blob/main/routes/app.php"
click node_event_http "https://github.com/bushra-mustafa/methaq/tree/main/app/Http/Controllers/App"
click node_event_domain "https://github.com/bushra-mustafa/methaq/tree/main/app/Domains/Events"
click node_event_store "https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Events/Models/Event.php"
click node_invitation "https://github.com/bushra-mustafa/methaq/blob/main/app/Http/Controllers/Guest/ShowInvitationController.php"
click node_editor_ui "https://github.com/bushra-mustafa/methaq/tree/main/resources/js/Domains/Editor"
click node_editor_save "https://github.com/bushra-mustafa/methaq/blob/main/resources/js/Domains/Editor/Services/designSaveClient.ts"
click node_design_model "https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Editor/Models/EventDesign.php"
click node_templates "https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Editor/Models/Template.php"
click node_proposals "https://github.com/bushra-mustafa/methaq/tree/main/resources/js/Domains/Editor/Proposals/Ivory"
click node_payments "https://github.com/bushra-mustafa/methaq/tree/main/app/Domains/Payments"
click node_orders "https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Payments/Models/Order.php"
click node_rsvp "https://github.com/bushra-mustafa/methaq/tree/main/app/Domains/RSVP"
click node_rsvp_store "https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/RSVP/Models/Rsvp.php"
click node_users "https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Users/Models/User.php"
click node_support "https://github.com/bushra-mustafa/methaq/tree/main/app/Domains/Users"
click node_whatsapp "https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Users/Actions/ProcessCloudMsgWebhookAction.php"
click node_admin "https://github.com/bushra-mustafa/methaq/tree/main/app/Filament"

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_public,node_app_routes,node_event_http,node_admin toneBlue
class node_event_domain,node_event_store,node_invitation toneAmber
class node_editor_ui,node_editor_save,node_design_model,node_templates,node_proposals toneMint
class node_payments,node_orders,node_rsvp,node_rsvp_store toneRose
class node_users,node_support,node_whatsapp,node_owner,node_guest,node_cloudmsg toneIndigo
```

## Components

### Web Experience

- [Public site](https://github.com/bushra-mustafa/methaq/tree/main/resources/js/Components/Public): `resources/js/Components/Public`
- [App routes](https://github.com/bushra-mustafa/methaq/blob/main/routes/app.php): `routes/app.php`
- [Event controllers](https://github.com/bushra-mustafa/methaq/tree/main/app/Http/Controllers/App): `app/Http/Controllers/App`
- [Filament admin](https://github.com/bushra-mustafa/methaq/tree/main/app/Filament): `app/Filament`

### Events & Publishing

- [Event lifecycle](https://github.com/bushra-mustafa/methaq/tree/main/app/Domains/Events): `app/Domains/Events`
- [Event records](https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Events/Models/Event.php): `app/Domains/Events/Models/Event.php`
- [Guest invitation](https://github.com/bushra-mustafa/methaq/blob/main/app/Http/Controllers/Guest/ShowInvitationController.php): `app/Http/Controllers/Guest/ShowInvitationController.php`

### Invitation Studio

- [Design editor](https://github.com/bushra-mustafa/methaq/tree/main/resources/js/Domains/Editor): `resources/js/Domains/Editor`
- [Design save client](https://github.com/bushra-mustafa/methaq/blob/main/resources/js/Domains/Editor/Services/designSaveClient.ts): `resources/js/Domains/Editor/Services/designSaveClient.ts`
- [Design documents](https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Editor/Models/EventDesign.php): `app/Domains/Editor/Models/EventDesign.php`
- [Template library](https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Editor/Models/Template.php): `app/Domains/Editor/Models/Template.php`
- [Ivory proposals](https://github.com/bushra-mustafa/methaq/tree/main/resources/js/Domains/Editor/Proposals/Ivory): `resources/js/Domains/Editor/Proposals/Ivory`

### Payments & RSVP

- [Manual payments](https://github.com/bushra-mustafa/methaq/tree/main/app/Domains/Payments): `app/Domains/Payments`
- [Orders](https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Payments/Models/Order.php): `app/Domains/Payments/Models/Order.php`
- [Guest responses](https://github.com/bushra-mustafa/methaq/tree/main/app/Domains/RSVP): `app/Domains/RSVP`
- [RSVP records](https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/RSVP/Models/Rsvp.php): `app/Domains/RSVP/Models/Rsvp.php`

### Accounts & Messaging

- [Accounts & roles](https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Users/Models/User.php): `app/Domains/Users/Models/User.php`
- [Customer support](https://github.com/bushra-mustafa/methaq/tree/main/app/Domains/Users): `app/Domains/Users`
- [WhatsApp messaging](https://github.com/bushra-mustafa/methaq/blob/main/app/Domains/Users/Actions/ProcessCloudMsgWebhookAction.php): `app/Domains/Users/Actions/ProcessCloudMsgWebhookAction.php`

### Other components

- **Event owner**
- **Invitation guest**
- **CloudMsg provider**

## Connections

- Event owner → Public site: browses templates (evidence: `README.md`)
- Event owner → App routes: uses app (evidence: `routes/app.php`)
- App routes → Event controllers: routes requests (evidence: `routes/app.php`)
- Event controllers → Event lifecycle: runs actions (evidence: `app/Http/Controllers/App/ExportEventRsvpsController.php`)
- Event lifecycle → Event records: reads and writes (evidence: `app/Domains/Events/Models/Event.php`)
- Event records → Design documents: has design (evidence: `app/Domains/Events/Models/Event.php`)
- Event records → Template library: uses template (evidence: `app/Domains/Events/Models/Event.php`)
- Event controllers → Design editor: renders editor (evidence: `README.md`)
- Design editor → Design save client: saves design (evidence: `resources/js/Domains/Editor/Services/designSaveClient.ts`)
- Design save client → Design documents: submits document
- Event controllers → Manual payments: handles payment (evidence: `README.md`)
- Manual payments → Orders: records payment (evidence: `app/Domains/Payments/Models/PaymentWebhook.php`)
- Filament admin → Orders: reviews receipt (evidence: `README.md`)
- Event controllers → Event lifecycle: publishes invitation (evidence: `README.md`)
- Invitation guest → Guest invitation: opens link (evidence: `README.md`)
- Guest invitation → Event records: loads published event (evidence: `app/Http/Controllers/Guest/ShowInvitationController.php`)
- Invitation guest → Guest responses: submits response (evidence: `README.md`)
- Guest responses → RSVP records: stores response (evidence: `app/Domains/RSVP/Models/Rsvp.php`)
- Event controllers → Guest responses: exports responses (evidence: `app/Http/Controllers/App/ExportEventRsvpsController.php`)
- Event owner → Ivory proposals: edits proposal (evidence: `README.md`)
- Event owner → Customer support: contacts support (evidence: `README.md`)
- Event owner → WhatsApp messaging: requests publish (evidence: `app/Domains/Users/Actions/ProcessCloudMsgWebhookAction.php`)
- CloudMsg provider → WhatsApp messaging: sends webhook
- WhatsApp messaging → Event lifecycle: requests publish (evidence: `app/Domains/Users/Actions/ProcessCloudMsgWebhookAction.php`)
- WhatsApp messaging → CloudMsg provider: queues replies
- Event owner → Accounts & roles: manages account (evidence: `README.md`)
- Filament admin → Template library: manages library (evidence: `README.md`)
