Skip to content

Commit

Permalink
Update README.MD
Browse files Browse the repository at this point in the history
  • Loading branch information
zunnu committed Feb 14, 2021
1 parent c593575 commit 7fda2f9
Showing 1 changed file with 36 additions and 4 deletions.
40 changes: 36 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,43 @@
# AssociationsDebugger plugin for CakePHP

## Installation
AssociationsDebugger is a simple plugin that is made for debugging associations.
The point of this plugin is to quickly show different associations of your CakePHP application without you needing to browse through the model files.

You can install this plugin into your CakePHP application using [composer](https://getcomposer.org).

The recommended way to install composer packages is:
## Requirements
* CakePHP 3.x
* PHP 7.2 >

## Installing Using [Composer][composer]

`cd` to the root of your app folder (where the `composer.json` file is) and run the following command:

```
composer require zunnu/AssociationsDebugger
```

Then load the plugin by using CakePHP's console:

```
composer require your-name-here/AssociationsDebugger
./bin/cake plugin load AssociationsDebugger
```

## Usage
You can see the tree by going to
http:https://app-address/associations-debugger
Here you can filter by **association type**.
<img src="https://i.imgur.com/aEqreKN.png" alt="Tree">

This same tree can be also viewed in the CakePHP debugKit.
<img src="https://i.imgur.com/NoHfOQp.png" alt="DebugKit tree">

Association structure is explained here:
<img src="https://i.imgur.com/fYxikgt.png" alt="Structure">

## License

Licensed under [The MIT License][mit].

[cakephp]:http:https://cakephp.org
[composer]:http:https://getcomposer.org
[mit]:http:https://www.opensource.org/licenses/mit-license.php

0 comments on commit 7fda2f9

Please sign in to comment.