Download the PHP package cleaniquecoders/laravel-db2doc without Composer
On this page you can find all versions of the php package cleaniquecoders/laravel-db2doc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cleaniquecoders/laravel-db2doc
More information about cleaniquecoders/laravel-db2doc
Files in cleaniquecoders/laravel-db2doc
Package laravel-db2doc
Short Description Laravel Db2Doc generate your database schema documentation easily.
License MIT
Informations about the package laravel-db2doc
About Your Package
Laravel Db2Doc enable you to generate your database schema to markdown or JSON format.
Installation
-
In order to install
cleaniquecoders/laravel-db2doc
in your Laravel project, just run the composer require command from your terminal: -
Then in your
config/app.php
add the following to the providers array: - In the same
config/app.php
add the following to the aliases array:
Usage
Run php artisan db:2doc
, to generate the document in JSON format by default. File generated at storage/app/db2doc
directory.
Run php artisan db:2doc --database=sqlite
option to specify which database connection to use.
Run php artisan db:2doc --format=json
to export output as JSON. Default is in markdown format.
Run php artisan db:2doc --emoji
to have output as emoji.
Run php artisan db:2doc --path=path/to/other/output
to have output to other location.
Test
To run the test, type vendor/bin/phpunit
in your terminal.
To have codes coverage, please ensure to install PHP XDebug then run the following command:
Contributing
Thank you for considering contributing to the cleaniquecoders/laravel-db2doc
!
Bug Reports
To encourage active collaboration, it is strongly encourages pull requests, not just bug reports. "Bug reports" may also be sent in the form of a pull request containing a failing test.
However, if you file a bug report, your issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix.
Remember, bug reports are created in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the bug report will automatically see any activity or that others will jump to fix it. Creating a bug report serves to help yourself and others start on the path of fixing the problem.
Coding Style
cleaniquecoders/laravel-db2doc
follows the PSR-2 coding standard and the PSR-4 autoloading standard.
You may use PHP CS Fixer in order to keep things standardised. PHP CS Fixer configuration can be found in .php_cs
.
License
This package is open-sourced software licensed under the MIT license.
All versions of laravel-db2doc with dependencies
illuminate/filesystem Version ^5.5|^5.6|^5.7|^5.8|^6.0|^7.0|^8.0
illuminate/support Version ^5.5|^5.6|^5.7|^5.8|^6.0|^7.0|^8.0
illuminate/auth Version ^5.5|^5.6|^5.7|^5.8|^6.0|^7.0|^8.0
doctrine/dbal Version ^2.7