bekwoh / laravel-db-doc
Generate Database Schema Documentation
Requires
- php: ^8.1 | ^8.2 | ^8.3
- doctrine/dbal: ^3.4
- illuminate/contracts: ^9.0 | ^10.0 | ^11.0
- spatie/laravel-package-tools: ^1.14.0
Requires (Dev)
- larastan/larastan: ^2.9
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.0
- orchestra/testbench: ^8.0 | ^9.0
- pestphp/pest: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpunit/phpunit: ^9.5 | ^10.0
README
Generate Database Schema Documentation
A package to provide you easy way to generate Markdown / JSON format of database schema. Viewable in non-production environment at your http://domain.com/doc/db-schema.
Installation
You can install the package via composer:
composer require cleaniquecoders/laravel-db-doc
Add the following in your route file:
use CleaniqueCoders\LaravelDbDoc\LaravelDbDoc; LaravelDbDoc::routes();
You can publish the config file with:
php artisan vendor:publish --tag="db-doc-config"
Optionally, you can publish the views using
php artisan vendor:publish --tag="laravel-db-doc-views"
Usage
To generate database schema in Markdown format:
php artisan db:schema
To generate database schema in JSON format:
php artisan db:schema --format=json
To generate database schema for specific connection:
php artisan db:schema --database=sqlite
To generate output to specific storage, add in .env:
LARAVEL_DB_DOC_MARKDOWN_DISK=s3 LARAVEL_DB_DOC_JSON_DISK=s3
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.