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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package laravel-db2doc

Build Status Latest Stable Version Total Downloads Scrutinizer Code Quality License

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:

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

  3. 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

PHP Build Version
Package Version
Requires php Version >=7.3
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
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package cleaniquecoders/laravel-db2doc contains the following files

Loading the files please wait ....