Crear un diagrama entidad-relación en Eloquent

Cuando una nueva persona hace onboarding en un proyecto, conocer cómo funciona la base de datos es una de las tareas más difíciles, pero se puede hacer más llevadero teniendo un diagrama entidad-relación actualizado.

Crear un diagrama entidad-relación en Eloquent
Photo by Pawel Czerwinski / Unsplash

Uno de los aspectos más interesantes de Eloquent son las relaciones entre diferentes modelos. Cuando una nueva persona hace onboarding en un proyecto, conocer cómo funciona la base de datos es una de las tareas más difíciles, pero se puede hacer más llevadero teniendo un diagrama entidad-relación actualizado.

Gracias al ecosistema Laravel, disponer de este esquema es una tarea sencilla. Solo hay que instalar este paquete y ejecutar un par de comandos:

composer require kevincobain2000/laravel-erd --dev

A continuación, podemos publicar el fichero de configuración:

php artisan vendor:publish --provider="Kevincobain2000\LaravelERD\LaravelERDServiceProvider"

Tras ejecutar estos dos pasos, automáticamente podremos ver nuestro diagrama entidad-relación en http://localhost:8000/erd:

Al hacer esto, el diagrama es dinámico, por lo que es posible que tarde varios segundos en aparecer en pantalla. Otra posibilidad es ejecutar el siguiente comando:

php artisan erd:generate

Tras ejecutar este comando, se creará un fichero en la carpeta docs/erd/index.html. Si abrimos este fichero con nuestro navegador, la carga será instantánea :-)