README.md

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

• Nasrul Hazim Bin Mohamad
• All Contributors

License

The MIT License (MIT). Please see License File for more information.