# bryanmums/planit architecture

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

- Interactive diagram: https://gitdiagram.com/bryanmums/planit
- Repository: https://github.com/bryanmums/planit

## Overview

##### Project type and purpose
- This is a full-stack web application (“Plan_it_”) built on the Laravel PHP framework. Its purpose is project planning and management: user authentication, project creation, budgeting, resource assignment, Gantt chart generation, and statistics.

##### File structure
- Top-level directories:
- code/app – Models (`User`, `Project`, `GanttTask`, etc.), Controllers (MVC), Middleware, Console commands, Providers
- code/config – Laravel configuration (database, cache, mail, queue, services)
- code/database – Migrations and seeders defining schema: users, projects, collaborators, resources, costs, Gantt tasks, dependencies, pivot tables
- code/resources – Frontend assets (Vue components, Sass, JS), Blade templates under views
- code/public – Entry point (`index.php`), compiled CSS/JS, fonts/images
- code/routes – HTTP (`web.php`), API (`api.php`), console commands
- code/storage – Sessions, cache, logs, file uploads
- code/tests – PHPUnit test suite
- Build tools: `composer.json`, `package.json`, `gulpfile.js` for asset compilation
- Deployment scripts: `server.php` (built-in PHP server), `.env.example` for environment variables

##### README for additional insights
- Core features: authentication, project CRUD, budget/resource management, interactive Gantt chart editing, progress statistics
- Secondary objectives hint at social login, export functionality, GitHub integration (not yet implemented)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    subgraph "Client Layer"
        Browser["Browser / Mobile UI\n(Vue.js Components + Blade Templates)"]:::frontend
    end

    %% Server Layer
    subgraph "Server Layer"
        WebServer["Nginx/Apache + PHP-FPM"]:::core
        index["public/index.php"]:::core
        subgraph "Middleware"
            CSRF["CSRF Middleware"]:::core
            AuthM["Auth Middleware"]:::core
        end
        subgraph "Routing"
            WebRouter["Laravel Router (Web)"]:::core
            ApiRouter["Laravel Router (API)"]:::core
            ConsoleRouter["Console Routes"]:::core
        end
        subgraph "Controllers"
            HomeCtrl["HomeController"]:::core
            ProjectsCtrl["ProjectsController"]:::core
            GanttTasksCtrl["GanttTasksController"]:::core
            GanttDepsCtrl["GanttTasksDependenciesController"]:::core
            CostsCtrl["CostsController"]:::core
            ResourcesCtrl["ResourcesController"]:::core
            CollaboratorsCtrl["CollaboratersController"]:::core
            LoginCtrl["Auth\\LoginController"]:::core
            RegisterCtrl["Auth\\RegisterController"]:::core
            ForgotPwdCtrl["Auth\\ForgotPasswordController"]:::core
            ResetPwdCtrl["Auth\\ResetPasswordController"]:::core
        end
        subgraph "Services & Models"
            Providers["Service Providers"]:::core
            subgraph "Models"
                UserModel["User"]:::core
                ProjectModel["Project"]:::core
                GanttTaskModel["GanttTask"]:::core
                GanttDepModel["GanttTasksDependencie"]:::core
                CostModel["Cost"]:::core
                CollaboratorModel["Collaborater"]:::core
                ResourceModel["Resource"]:::core
            end
        end
        AssetBundler["Gulp/Webpack\n(asset pipeline)"]:::core
        QueueWorker["Queue Workers"]:::core
    end

    %% Data Layer
    subgraph "Data Layer"
        DB["MySQL / PostgreSQL"]:::data
        Cache["Redis / DB Queues"]:::data
        Storage["File Storage\n(Local or S3)"]:::data
    end

    %% External Services
    subgraph "External Services"
        Mail["Mail Server"]:::external
        OAuth["OAuth Providers"]:::external
        GitHubAPI["GitHub API"]:::external
    end

    %% Flows
    Browser -->|"HTTP/HTTPS Request"| WebServer
    WebServer --> index
    index --> CSRF --> AuthM --> WebRouter
    WebRouter --> HomeCtrl
    WebRouter --> ProjectsCtrl
    WebRouter --> GanttTasksCtrl
    WebRouter --> GanttDepsCtrl
    WebRouter --> CostsCtrl
    WebRouter --> ResourcesCtrl
    WebRouter --> CollaboratorsCtrl
    WebRouter --> LoginCtrl
    WebRouter --> RegisterCtrl
    WebRouter --> ForgotPwdCtrl
    WebRouter --> ResetPwdCtrl
    ApiRouter --> ProjectsCtrl
    ApiRouter --> GanttTasksCtrl
    ApiRouter --> CostsCtrl
    ConsoleRouter --> ProjectsCtrl
    ConsoleRouter --> QueueWorker

    HomeCtrl --> Providers --> UserModel
    ProjectsCtrl --> Providers --> ProjectModel
    GanttTasksCtrl --> Providers --> GanttTaskModel
    GanttDepsCtrl --> Providers --> GanttDepModel
    CostsCtrl --> Providers --> CostModel
    ResourcesCtrl --> Providers --> ResourceModel
    CollaboratorsCtrl --> Providers --> CollaboratorModel

    %% Data interactions
    Providers --> DB
    Providers --> Cache
    Providers --> Storage

    %% Asset requests
    Browser -->|"GET /css, /js"| AssetBundler
    AssetBundler --> index

    %% Queue and external
    ProjectsCtrl -->|"Dispatch Job"| QueueWorker
    QueueWorker --> DB
    QueueWorker --> Mail
    ProjectsCtrl --> OAuth
    ProjectsCtrl --> GitHubAPI

    %% Click Events
    click WebRouter "https://github.com/bryanmums/planit/blob/master/code/routes/web.php"
    click ApiRouter "https://github.com/bryanmums/planit/blob/master/code/routes/api.php"
    click ConsoleRouter "https://github.com/bryanmums/planit/blob/master/code/routes/console.php"
    click index "https://github.com/bryanmums/planit/blob/master/code/public/index.php"
    click HomeCtrl "https://github.com/bryanmums/planit/blob/master/code/app/Http/Controllers/HomeController.php"
    click ProjectsCtrl "https://github.com/bryanmums/planit/blob/master/code/app/Http/Controllers/ProjectsController.php"
    click GanttTasksCtrl "https://github.com/bryanmums/planit/blob/master/code/app/Http/Controllers/GanttTasksController.php"
    click GanttDepsCtrl "https://github.com/bryanmums/planit/blob/master/code/app/Http/Controllers/GanttTasksDependenciesController.php"
    click CostsCtrl "https://github.com/bryanmums/planit/blob/master/code/app/Http/Controllers/CostsController.php"
    click ResourcesCtrl "https://github.com/bryanmums/planit/blob/master/code/app/Http/Controllers/ResourcesController.php"
    click CollaboratorsCtrl "https://github.com/bryanmums/planit/blob/master/code/app/Http/Controllers/CollaboratersController.php"
    click LoginCtrl "https://github.com/bryanmums/planit/blob/master/code/app/Http/Controllers/Auth/LoginController.php"
    click RegisterCtrl "https://github.com/bryanmums/planit/blob/master/code/app/Http/Controllers/Auth/RegisterController.php"
    click ForgotPwdCtrl "https://github.com/bryanmums/planit/blob/master/code/app/Http/Controllers/Auth/ForgotPasswordController.php"
    click ResetPwdCtrl "https://github.com/bryanmums/planit/blob/master/code/app/Http/Controllers/Auth/ResetPasswordController.php"
    click UserModel "https://github.com/bryanmums/planit/blob/master/code/app/User.php"
    click ProjectModel "https://github.com/bryanmums/planit/blob/master/code/app/Project.php"
    click GanttTaskModel "https://github.com/bryanmums/planit/blob/master/code/app/GanttTask.php"
    click GanttDepModel "https://github.com/bryanmums/planit/blob/master/code/app/GanttTasksDependencie.php"
    click CostModel "https://github.com/bryanmums/planit/blob/master/code/app/Cost.php"
    click CollaboratorModel "https://github.com/bryanmums/planit/blob/master/code/app/Collaborater.php"
    click ResourceModel "https://github.com/bryanmums/planit/blob/master/code/app/Resource.php"
    click Providers "https://github.com/bryanmums/planit/tree/master/code/app/Providers"
    click AssetBundler "https://github.com/bryanmums/planit/blob/master/code/gulpfile.js"
    click AssetBundler "https://github.com/bryanmums/planit/blob/master/code/package.json"
    click AssetBundler "https://github.com/bryanmums/planit/blob/master/code/composer.json"

    %% Styles
    classDef frontend fill:#D6E9FE,stroke:#2B6CB0,color:#2B6CB0;
    classDef core fill:#E6FFFA,stroke:#2C7A7B,color:#2C7A7B;
    classDef data fill:#FFF5E6,stroke:#DD6B20,color:#DD6B20;
    classDef external fill:#F5E6FF,stroke:#805AD5,color:#805AD5;
```
