README

Overview

Laravel Decomposer decomposes and lists all the installed packages and their dependencies along with the Laravel & the Server environment details your app is running in. Decomposer also generates a markdown report from those details that can be used for troubleshooting purposes, also it allows you to generate the same report as an array and also as JSON anywhere in your code. Laravel Package & app devs you can also add your own personal extra stats specific for your package or your app. All these just on the hit of a single route.

Features

• This can be used by your non-tech client/user of your laravel app or non-experienced dev who still dosen't uses CLI to generate the system report & send over to you so you can know the entire details of his environment.
• To see the list of all installed packages & their dependencies in the laravel app directly from the browser
• To get the Laravel & Server environment details on the same page with the packages list
• To check whether all the pre configurations & extensions asked by Laravel are applied and loaded or not
• Suppose suddenly or after some changes your app broke, you can install Laravel Decomposer, generate & copy the report and paste it in the issue box of the respective repo you are reporting the issue to.
• For package/laravel app developers this can be very useful when collecting the information from the users reporting the issues. As the report gives them complete info about the environment the issue is being raised in.
• It can also help you in other ways like suppose you have a package installed that is using illuminate/support v5.1, and an another package using illuminate/support v5.3, so getting these facts quickly by just hitting to a route can make you aware of possible unstability & conflicts so you can report that to the respective package developer.
• It cuts down the troubleshooting time. For eg: Sometimes after trying all possible solutions at the end the user says 'I forgot to say I am on PHP 4'. Here Decomposer acts as the precaution & removes the dependency of querying the user for every single thing.

Roadmap

• Allow Decomposer report to be accessed via code Released in v1.1
• Allow users and other packages to add their own stats in the Decomposer report Released in v1.2
• Migrate UI framework from Bootstrap 3 CDN and jQuery to Tailwind CSS and Alpine.js for a modern, lightweight frontend with tighter integration into the Laravel ecosystem.
• Add a config file to allow user to control what he/she wants to see in the view
• Check for updates of the installed packages & show if any available for the respective packages or their dependencies
• Compare same dependency versions for different packages & warn user about the possible conflict. (Can be achieved even now as the search results highlighting is enabled, but sure it can be done in more better way)
• Make UI more informative & UX more better
• Let us know if you want anything to be added in the decomposer. After all the user makes the packages worth :)
• We have created the issues & labels with the appropriate titles , where you can contribute your ideas & suggestions or let us know if you are working on a PR for that. Always more than happy to hear & learn new things from the community.

Note

You can have a look at the Roadmap. If you have any suggestions for code improvements, new optional or core features or enhancements, create an issue so you,us or any open source believer can start working on it.

Requirement

• PHP >= 7.1.3

Compatibility

• Laravel 6.x through 13.x

Installation

1. Install the package

composer require lubusin/laravel-decomposer

2. Publish the package config (optional)

php artisan vendor:publish --tag=DecomposerConfig

After publishing, update config/decomposer.php and set exclude_folders to control which folders are ignored while calculating app_size.

3. Publish the package assets

php artisan vendor:publish --tag=DecomposerAssets --force

4. Add a route in your routes/web.php

use Lubusin\Decomposer\Controllers\DecomposerController;

Route::get('decompose', [DecomposerController::class, 'index']);

5. Visit the Decomposer UI

Go to http://yourapp/decompose or the route you configured above.

Usage

The Docs can be found in the Wiki but to save you one more click, here's the index

• Add your own extra stats for your package or app
• Get Decomposer report as markdown
• Get Decomposer report as an array
• Get Decomposer report as JSON

Contributing

Thank you for considering contributing to the Laravel Decomposer. You can read the contribution guide lines here

If you discover a security vulnerability within Laravel, please send an e-mail at info@lubus.in. All security vulnerabilities will be promptly addressed.

Development

1. Clone the Repository

Clone the repository to your local system:

git clone git@github.com:lubusIN/laravel-decomposer.git 

2. Go to package folder

cd laravel-decomposer

3. Create your development branch

git checkout -b your-branch

4. Link your development branch in your Laravel project

In your Laravel project, require your local package using Composer’s path repository feature. Add the following to your Laravel project's composer.json:

"repositories": [
    {
        "type": "path",
        "url": "../path-to-your-cloned-laravel-decomposer"
    }
]

Then require it using:

composer require lubusin/laravel-decomposer:dev-your-branch

Meet Your Artisans

LUBUS is a web design agency based in Mumbai, India.

License

Laravel Decomposer is open-sourced software licensed under the MIT license