An open API service indexing awesome lists of open source software.

https://github.com/dynamik-dev/db-chart


https://github.com/dynamik-dev/db-chart

Last synced: 10 months ago
JSON representation

Awesome Lists containing this project

README

          

## DbChart

This package is a simple package that allows you to generate a Mermaid diagram of your database schema. It will update in real time as you make changes to your database.

![Screenshot of the diagram](./screenshot.png)

> [!WARNING]
> This package is intended for development use only and is simply a POC. Do not use in production environments as it exposes your database schema.

## Installation

```bash
composer require dynamikdev/db-chart
```

## Usage

Visit `/db-chart` to see the diagram!.

## Configuration

### Authorization

You can configure the package by adding a callback to the `DbChartServiceProvider` class. Here's an example of how to authorize the diagram to only be visible to authenticated users.

```php
// AppServiceProvider.php
public function register()
{
DbChartServiceProvider::authorizeUsing(function () {
return auth()->check();
});
}
```