# ericrosenberg1/nonprofit-manager architecture

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

- Interactive diagram: https://gitdiagram.com/ericrosenberg1/nonprofit-manager
- Repository: https://github.com/ericrosenberg1/nonprofit-manager

## Overview

##### Project Type and Purpose
- This is a WordPress plugin (“Nonprofit Manager”) whose goal is to help nonprofits manage members, donations, emails/newsletters, events, and payments.
- It provides Gutenberg blocks, shortcodes, admin pages, background tasks (via WP-Cron), and integrations with external services (SMTP email providers, PayPal).

##### File Structure
- Top‐level:
- nonprofit-manager.php – the plugin bootstrap (registers hooks, loads modules).
- assets/js – front-end scripts (donation form, block scripts).
- blocks/ – Gutenberg block registrations (email composer).
- includes/ – the core PHP modules:
– activation-hooks.php
– email-newsletter/ (editor UI, manager/tracker classes, reports, templates)
– email/smtp.php
– npmp-*.php (admin settings, calendar, email-delivery, email-newsletter, email-settings, members, membership forms, payments settings, scripts)
– payments/npmp-paypal.php
- How each feature (Members, Payments, Email, Calendar) lives in its own module under includes.

##### README for Additional Insights
- Features: transactional email setup, payment gateway configuration, Gutenberg Email Composer, shortcodes for forms.
- External services: SMTP mailer (configurable), PayPal SDK/data flow.
- Background tasks: email queueing and delivery via WP-Cron.
- Data storage: plugin settings and sensitive keys in the wp_options table; likely custom database tables or post types for members, events.

##### Main Components and Their Interactions
a. Frontend Layer:
- WordPress Core (theme + plugins)
- Shortcode handlers (in includes/npmp-*.php) render HTML forms and Gutenberg blocks (blocks/email-composer.js).
- assets/js → donation-form.js loads PayPal SDK; np-blocks.js registers/enhances blocks.
b. Plugin Backend:
- nonprofit-manager.php loads activation hooks and module files.
- includes/*.php classes and functions handle admin UI (Settings pages), business logic (Member management, Donations, Events), routing hooks (REST endpoints or admin_post).
- includes/email-newsletter/* manages email composition, queueing, template rendering, and reporting.
c. Data Storage:
- WP Options table for storing plugin settings (API keys, defaults).
- Possibly custom DB tables or custom post types for members, events, and queued emails (not explicitly shown, but implied).
d. Background Tasks:
- WP-Cron jobs trigger email delivery logic in includes/npmp-email-delivery.php and class-newsletter-tracker.php.
e. External Services:
- SMTP Server (configured via includes/email/smtp.php)
- PayPal API (npmp-paypal.php) – loaded in donation-form.js, invoked on form submission.

##### Architectural Patterns and Design Principles
- Modular design: each feature is encapsulated under includes/ with its own settings, UI, and business logic.
- Separation of concerns: frontend assets (blocks, JS) are kept separate from backend PHP.
- WordPress hook system: uses activation hooks, shortcodes, admin menus, WP-Cron, and possibly REST hooks.
- Extensibility: Gutenberg blocks, shortcode APIs, settings pages allow future extension.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Client
    subgraph "Frontend Client" 
        direction TB
        Browser["Browser"]:::client
    end

    %% WordPress Core
    subgraph "WordPress Core" 
        direction TB
        WPEngine["WP Engine + Theme"]:::wordpress
    end

    %% Plugin Container
    subgraph "Nonprofit Manager Plugin" 
        direction TB
        Bootstrap["Plugin Bootstrap\n(nonprofit-manager.php)"]:::plugin
        ActivationHooks["Activation Hooks\n(includes/activation-hooks.php)"]:::plugin
        subgraph "Frontend Scripts" 
            direction TB
            DonationFormJS["Donation Form JS\n(assets/js/donation-form.js)"]:::js
            NPBlocksJS["Blocks Enhancer JS\n(assets/js/np-blocks.js)"]:::js
        end
        GutenbergLoader["Gutenberg Blocks Loader\n(includes/npmp-blocks.php)"]:::plugin
        BlockSource["Email Composer Block\n(blocks/email-composer.js)"]:::js

        subgraph "Email Newsletter Module" 
            direction TB
            ENEntry["Newsletter Module Entry\n(includes/npmp-email-newsletter.php)"]:::plugin
            ENEditorInit["Editor Init\n(includes/email-newsletter/editor.php)"]:::plugin
            ENEditorUI["Editor UI Script\n(includes/email-newsletter/assets/newsletter-editor.js)"]:::js
            ENShortcode["Shortcode Support\n(includes/email-newsletter/can-spam-shortcode.php)"]:::plugin
            ENManager["Manager Class\n(includes/email-newsletter/class-newsletter-manager.php)"]:::plugin
            ENTracker["Tracker Class\n(includes/email-newsletter/class-newsletter-tracker.php)"]:::plugin
            ENReports["Reports\n(includes/email-newsletter/reports.php)"]:::plugin
            ENSettings["Settings Page\n(includes/email-newsletter/settings.php)"]:::plugin
            ENTemplates["Template Rendering\n(includes/email-newsletter/templates.php)"]:::plugin
        end

        SMTPIntegration["SMTP Integration\n(includes/email/smtp.php)"]:::plugin
        EmailDelivery["Email Delivery Cron Handler\n(includes/npmp-email-delivery.php)"]:::plugin

        AdminSettings["Admin Dashboard\n(includes/npmp-admin-settings.php)"]:::plugin
        EmailSettings["Email Settings Page\n(includes/npmp-email-settings.php)"]:::plugin
        MembersSettings["Members Settings Page\n(includes/npmp-members-settings.php)"]:::plugin
        MembershipForms["Membership Forms\n(includes/npmp-membership-forms.php)"]:::plugin
        CalendarModule["Calendar Module\n(includes/npmp-calendar.php)"]:::plugin
        PaymentsSettings["Payments Settings Page\n(includes/npmp-payments-settings.php)"]:::plugin
        ScriptsLoader["Scripts Enqueue Loader\n(includes/npmp-scripts.php)"]:::plugin
        PayPalIntegration["PayPal Integration\n(includes/payments/npmp-paypal.php)"]:::plugin
    end

    %% Database
    Database[(MySQL DB\nwp_options, CPTs)]:::database

    %% Scheduler
    Scheduler["WP-Cron Scheduler"]:::scheduler

    %% External Services
    subgraph "External Services"
        direction TB
        SMTP["SMTP Server"]:::external
        PayPalAPI["PayPal API"]:::external
    end

    %% Connections
    Browser -->|"HTTP Request"| WPEngine
    WPEngine -->|"Load Plugin"| Bootstrap
    Bootstrap --> ActivationHooks
    Bootstrap --> ScriptsLoader
    ScriptsLoader --> DonationFormJS
    ScriptsLoader --> NPBlocksJS
    Bootstrap --> GutenbergLoader
    GutenbergLoader --> BlockSource
    BlockSource --> Browser
    Browser -->|"Load Donation Form"| DonationFormJS
    DonationFormJS -->|"Load PayPal SDK"| PayPalAPI
    Browser -->|"PayPal Payment"| PayPalAPI
    PayPalAPI -->|"Payment Callback"| PayPalIntegration
    PayPalIntegration --> Database
    Bootstrap --> AdminSettings
    AdminSettings --> Database
    Bootstrap --> EmailSettings
    EmailSettings --> Database
    Bootstrap --> MembersSettings
    MembersSettings --> Database
    Bootstrap --> MembershipForms
    MembershipForms --> Database
    Bootstrap --> CalendarModule
    CalendarModule --> Database

    %% Email flow
    Bootstrap --> ENEntry
    ENEntry --> ENEditorInit
    ENEditorInit --> ENEditorUI
    ENEntry --> ENShortcode
    ENEntry --> ENManager
    ENManager --> Database
    ENEntry --> ENTemplates
    ENEntry --> ENReports
    ENSettings --- ENEntry
    ENSettings --> Database
    Bootstrap --> SMTPIntegration
    SMTPIntegration --> SMTP
    Scheduler --> EmailDelivery
    EmailDelivery --> SMTPIntegration
    EmailDelivery --> Database

    %% Styles and Classes
    classDef client fill:#E3F2FD,stroke:#1976D2,color:#0D47A1
    classDef wordpress fill:#BBDEFB,stroke:#0D47A1,color:#0D47A1
    classDef plugin fill:#E8EAF6,stroke:#3949AB,color:#1A237E
    classDef js fill:#FFF3E0,stroke:#FB8C00,color:#E65100
    classDef database fill:#FFF8E1,stroke:#FFB300,color:#FF6F00
    classDef scheduler fill:#ECEFF1,stroke:#546E7A,color:#263238
    classDef external fill:#E8F5E9,stroke:#2E7D32,color:#1B5E20

    %% Click Events
    click Bootstrap "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/nonprofit-manager.php"
    click ActivationHooks "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/activation-hooks.php"
    click DonationFormJS "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/assets/js/donation-form.js"
    click NPBlocksJS "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/assets/js/np-blocks.js"
    click GutenbergLoader "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/npmp-blocks.php"
    click BlockSource "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/blocks/email-composer.js"
    click ENEntry "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/npmp-email-newsletter.php"
    click ENEditorUI "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/email-newsletter/assets/newsletter-editor.js"
    click ENShortcode "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/email-newsletter/can-spam-shortcode.php"
    click ENManager "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/email-newsletter/class-newsletter-manager.php"
    click ENTracker "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/email-newsletter/class-newsletter-tracker.php"
    click ENEditorInit "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/email-newsletter/editor.php"
    click ENReports "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/email-newsletter/reports.php"
    click ENSettings "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/email-newsletter/settings.php"
    click ENTemplates "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/email-newsletter/templates.php"
    click SMTPIntegration "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/email/smtp.php"
    click EmailDelivery "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/npmp-email-delivery.php"
    click EmailSettings "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/npmp-email-settings.php"
    click AdminSettings "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/npmp-admin-settings.php"
    click CalendarModule "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/npmp-calendar.php"
    click MembersSettings "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/npmp-members-settings.php"
    click MembershipForms "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/npmp-membership-forms.php"
    click PaymentsSettings "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/npmp-payments-settings.php"
    click ScriptsLoader "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/npmp-scripts.php"
    click PayPalIntegration "https://github.com/ericrosenberg1/nonprofit-manager/blob/main/includes/payments/npmp-paypal.php"
```
