cleaniquecoders/laravel-db2doc

This package is abandoned and no longer maintained. No replacement package was suggested.

Laravel Db2Doc generate your database schema documentation easily.

v2.0.0 2020-09-09 16:03 UTC

Requires

• php: >=7.3
• doctrine/dbal: ^2.7
• illuminate/auth: ^5.5|^5.6|^5.7|^5.8|^6.0|^7.0|^8.0
• illuminate/filesystem: ^5.5|^5.6|^5.7|^5.8|^6.0|^7.0|^8.0
• illuminate/support: ^5.5|^5.6|^5.7|^5.8|^6.0|^7.0|^8.0

Requires (Dev)

• mockery/mockery: ^1.1
• orchestra/testbench: 3.5.*|3.6.*|3.7.*|3.8.*|4.*|5.*|6.*
• phpunit/phpunit: ^6.5|^7.0|^8.0|^9.0

MIT

• Nasrul Hazim

• database
• documentation
• package
• laravel

README

About Your Package

Laravel Db2Doc enable you to generate your database schema to markdown or JSON format.

Installation

1. In order to install cleaniquecoders/laravel-db2doc in your Laravel project, just run the composer require command from your terminal:

$ composer require cleaniquecoders/laravel-db2doc

1. Then in your config/app.php add the following to the providers array:

CleaniqueCoders\LaravelDB2DOC\LaravelDB2DOCServiceProvider::class,

1. In the same config/app.php add the following to the aliases array:

'LaravelDB2DOC' => CleaniqueCoders\LaravelDB2DOC\LaravelDB2DOCFacade::class,

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:

$ vendor/bin/phpunit -v --coverage-text --colors=never --stderr

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.