# shahriarshaon1993/subscription-management architecture

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

- Interactive diagram: https://gitdiagram.com/shahriarshaon1993/subscription-management
- Repository: https://github.com/shahriarshaon1993/subscription-management

## Overview

##### Project type and purpose
- This is a full-stack Laravel monolithic web application for subscription management.
- Purpose: Allow users to browse plans, register, purchase via Stripe, and manage subscriptions/transactions.

##### File structure
- Top-level directories:
- app/ (HTTP controllers, middleware, models, providers)
- config/ (environment and service settings)
- database/ (migrations, factories, seeders)
- public/ (front controller index.php, static assets)
- resources/ (Blade views, CSS/JS assets via Vite)
- routes/ (web & console routes)
- storage/ (logs, cache, sessions, file uploads)
- tests/ (Feature & Unit tests)
- Architectural patterns:
- MVC (Models in app/Models, Views in resources/views, Controllers in app/Http/Controllers)
- Service integration (Stripe checkout and webhook handling in PlanController)
- Event/queue system (Laravel Jobs for asynchronous processing if configured)
- Role-based middleware (RoleMiddleware)

##### Key insights from README
- Uses Blade templates & Tailwind via Vite
- MySQL for persistent storage, optionally Redis for caching/queues
- Stripe for payment processing (checkout sessions + webhooks)
- Routes defined in routes/web.php (public) and middleware guards for auth

##### Main components and relationships
a. Frontend (Browser)
- Sends HTTP requests to Laravel (public/index.php)
- Renders views (Blade templates) & static assets
b. Web Server / Application Layer
- Nginx/Apache → public/index.php → Laravel HTTP Kernel
- Middleware (auth, role checks)
- Controllers (HomeController, PlanController, Auth controllers)
- Services: Stripe SDK integration, form validation, business logic
c. Persistence Layer
- MySQL database (users, roles, plans, subscriptions, transactions, jobs, cache)
- Eloquent ORM (Models)
d. Asynchronous/Queue Layer (optional if using queues)
- Laravel Queue workers
- Jobs for sending emails, processing webhooks, updating subscription status
e. External Services
- Stripe API (checkout, webhooks)
- Mail service (SMTP, configured in config/mail.php)
f. Storage
- Local or cloud storage for uploaded files (config/filesystems.php)

##### Architectural patterns & design principles
- MVC separation (clear model, view, controller layers)
- Single monolithic codebase with decoupled components via services
- Event-driven updates via Stripe webhooks
- Middleware for cross-cutting concerns (authentication, roles)
- Environment-based config for credentials (dotenv)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External UI
    Browser["Browser"]:::ui

    %% Web Server
    WebServer["Web Server\n(Nginx/Apache)"]:::server

    %% Laravel Application
    subgraph "Laravel Application"
        direction TB

        %% Bootstrap & Routing
        subgraph "Bootstrap & Routing"
            direction TB
            FrontController["public/index.php"]:::server
            HTTPKernel["bootstrap/app.php"]:::server
            RoutesWeb["routes/web.php"]:::server
            RoutesConsole["routes/console.php"]:::server
        end

        %% Middleware
        subgraph "Middleware"
            direction TB
            RoleMiddleware["RoleMiddleware"]:::middleware
        end

        %% Controllers
        subgraph "Controllers"
            direction TB
            HomeController["HomeController"]:::controller
            PlanController["PlanController"]:::controller
            LoginSessionController["LoginSessionController"]:::controller
            RegisteredUserController["RegisteredUserController"]:::controller
        end

        %% Form Requests
        subgraph "Form Request Validation"
            direction TB
            UserLoginRequest["UserLoginRequest"]:::request
            UserRegisterRequest["UserRegisterRequest"]:::request
        end

        %% Services & Stripe
        subgraph "Services"
            direction TB
            StripeService["Stripe SDK Integration"]:::service
            MailService["Mail Service\n(SMTP)"]:::service
        end

        %% Models
        subgraph "Eloquent Models"
            direction TB
            UserModel["User"]:::model
            RoleModel["Role"]:::model
            PlanModel["Plan"]:::model
            SubscriptionModel["Subscription"]:::model
            TransactionModel["Transaction"]:::model
        end
    end

    %% Persistence & Storage
    subgraph "Persistence & Storage"
        direction TB
        Database["MySQL Database"]:::db
        CacheQueue["Redis Cache/Queue"]:::queue
        StorageLocal["File Storage"]:::storage
    end

    %% External Stripe
    StripeAPI["Stripe API"]:::external

    %% Connections
    Browser -->|HTTP Request| WebServer
    WebServer -->|dispatch| FrontController
    FrontController -->|bootstraps| HTTPKernel
    HTTPKernel -->|loads| RoutesWeb
    HTTPKernel -->|loads| RoutesConsole
    RoutesWeb -->|routes to| RoleMiddleware
    RoleMiddleware -->|passes| HomeController
    RoleMiddleware -->|passes| PlanController
    RoleMiddleware -->|passes| LoginSessionController
    RoleMiddleware -->|passes| RegisteredUserController

    HomeController -->|validates via| UserLoginRequest
    RegisteredUserController -->|validates via| UserRegisterRequest

    PlanController -->|uses| StripeService
    HomeController -->|uses| MailService

    HomeController -->|CRUD| UserModel
    PlanController -->|CRUD| PlanModel
    PlanController -->|CRUD| SubscriptionModel
    PlanController -->|CRUD| TransactionModel
    RegisteredUserController -->|CRUD| UserModel

    UserModel -->|queries| Database
    RoleModel -->|queries| Database
    PlanModel -->|queries| Database
    SubscriptionModel -->|queries| Database
    TransactionModel -->|queries| Database

    PlanController -->|creates Checkout Session| StripeAPI
    StripeAPI -->|webhook event| RouteWebhook[/"Webhook Endpoint"/]:::server
    RouteWebhook -->|handles| PlanController

    PlanController -->|dispatch job| CacheQueue
    CacheQueue -->|processes| SubscriptionModel

    HomeController -->|logs, sessions| StorageLocal

    %% Click Events
    click FrontController "https://github.com/shahriarshaon1993/subscription-management/blob/main/public/index.php"
    click HTTPKernel "https://github.com/shahriarshaon1993/subscription-management/blob/main/bootstrap/app.php"
    click RoutesWeb "https://github.com/shahriarshaon1993/subscription-management/blob/main/routes/web.php"
    click RoutesConsole "https://github.com/shahriarshaon1993/subscription-management/blob/main/routes/console.php"
    click HomeController "https://github.com/shahriarshaon1993/subscription-management/blob/main/app/Http/Controllers/HomeController.php"
    click PlanController "https://github.com/shahriarshaon1993/subscription-management/blob/main/app/Http/Controllers/PlanController.php"
    click LoginSessionController "https://github.com/shahriarshaon1993/subscription-management/blob/main/app/Http/Controllers/Auth/LoginSessionController.php"
    click RegisteredUserController "https://github.com/shahriarshaon1993/subscription-management/blob/main/app/Http/Controllers/Auth/RegisteredUserController.php"
    click RoleMiddleware "https://github.com/shahriarshaon1993/subscription-management/blob/main/app/Http/Middleware/RoleMiddleware.php"
    click UserLoginRequest "https://github.com/shahriarshaon1993/subscription-management/blob/main/app/Http/Requests/UserLoginRequest.php"
    click UserRegisterRequest "https://github.com/shahriarshaon1993/subscription-management/blob/main/app/Http/Requests/UserRegisterRequest.php"
    click UserModel "https://github.com/shahriarshaon1993/subscription-management/blob/main/app/Models/User.php"
    click RoleModel "https://github.com/shahriarshaon1993/subscription-management/blob/main/app/Models/Role.php"
    click PlanModel "https://github.com/shahriarshaon1993/subscription-management/blob/main/app/Models/Plan.php"
    click SubscriptionModel "https://github.com/shahriarshaon1993/subscription-management/blob/main/app/Models/Subscription.php"
    click TransactionModel "https://github.com/shahriarshaon1993/subscription-management/blob/main/app/Models/Transaction.php"

    %% Styles
    classDef ui fill:#D0E6FF,stroke:#333;
    classDef server fill:#EEEEEE,stroke:#333;
    classDef middleware fill:#FFF5CC,stroke:#333;
    classDef controller fill:#CCFFCC,stroke:#333;
    classDef model fill:#CCFFCC,stroke:#333;
    classDef storage fill:#E2D4C3,stroke:#333;
    classDef db fill:#D5E8D4,stroke:#333;
    classDef queue fill:#FFE6CC,stroke:#333;
    classDef external fill:#E1D5E7,stroke:#333;
    classDef request fill:#FFE6CC,stroke:#333;
    classDef service fill:#F2F2F2,stroke:#333;
```
