[Laravel] Bidirectional Sync Between Migrations and ER Diagrams for Automated Documentation

Chikau Kume — Sat, 31 May 2025 14:46:55 +0000

Introduction

As many of you working in IT development may know, development documentation often becomes outdated or doesn't exist at all in most projects.

ER diagrams are one type of documentation that, even when created initially, rarely get updated and end up diverging from the actual database structure. As a result, only the current migration files can be trusted, forcing developers to read through migrations and actual tables one by one to understand the DB structure.

Of course, we should "update ER diagrams whenever we update the code."
However, low-priority tasks tend to get postponed, and before we know it, we're left with ER diagrams that are completely out of sync with reality...
Sound familiar?

That's why I've added bidirectional synchronization between Laravel migrations and ER diagrams (PlantUML) to LAC.

For details about LAC and installation instructions, please see my previous article:
https://dev.to/chikau/95-faster-laravel-development-meet-lac-30gp

With this feature, you can generate ER diagrams based on the latest source code with a single command, eliminating management overhead while enabling documentation creation and maintenance. While development documentation includes various elements like screen transitions and basic design documents, I believe having at least an ER diagram helps understand the most crucial aspect of any system - data flow. This motivated me to create this feature.

How to Use

# ER Diagram → Migration
1. Create a .puml file and place it in storage/app/db/diagrams
2. Run the following command:
php artisan lac:gen-migration
3. Migration files will be generated in database/migrations

# Migration → ER Diagram
1. Create migration files
2. Run the following command:
php artisan lac:gen-diagram
3. A .puml file will be generated in storage/app/db/diagrams/generated

For those who want to see it in action, please visit:
https://github.com/ChikauKume/laravel-arsenal-core/blob/main/README.md

Conclusion

Combined with the previously introduced Scaffold feature, this can significantly boost your development efficiency. Please give it a try!

📝 Feedback & Feature Requests

Feel free to share your requests and suggestions via GitHub Issues:
👉 https://github.com/ChikauKume/laravel-arsenal-core/issues

If you found this article helpful, please like, comment, and share!

🚀 95% Faster Laravel Development - Meet LAC!

Chikau Kume — Thu, 22 May 2025 14:47:14 +0000

Introduction

As Laravel developers, we frequently encounter these recurring development tasks:

Creating models, controllers, services, and request classes
Setting up routing
Writing validation rules
Defining model relationships
Importing test data

While these tasks are essential for development, they require significant time investment for repetitive work. In web development beyond Laravel, adding new resources involves similar repetitive processes, leading to these challenges:

Substantial time investment in non-business logic code creation
Quality variations due to different coding styles among developers
Potential errors from manual work such as configuration oversights and typos

To address these challenges, I developed Laravel Arsenal Core (LAC).

LAC implementation helps achieve the following:

✅ Significant speed improvement - Up to 95% reduction in development effort for common tasks
✅ Consistent code quality - Auto-generation based on Laravel best practices
✅ Reduced manual errors - Minimized manual configuration requirements

What This Tool Can Do

LAC is a toolkit that automates repetitive tasks in Laravel development while maintaining consistent code quality and substantially improving development speed.

Main Features

1. Comprehensive CRUD Scaffolding

Automatically creates Service and View files in addition to Laravel's standard capabilities
Generates complete CRUD framework following RESTful API patterns with seamless file integration

2. Automatic Route Synchronization

Generates optimized routes based on your controller structure

3. Excel Table Integration

Reads database structure from migration files and creates Excel templates for streamlined data import
Simple one-command data import using the generated templates

4. Automatic Model Relationship Generation

Analyzes migration files and creates appropriate model relationships

5. Automatic Validation Synchronization

Generates validation rules based on your migration column definitions

Architecture Design Philosophy

LAC is based on the following design principles:

Service Layer Pattern Adoption
- Clear separation of business logic from controllers
- Enhanced testability and improved separation of concerns
Streamlined Controller Design
- Controllers focused on input validation and service calls
- Improved readability and maintainability
Unified Project Structure
- Ensures consistency in team development
- Accelerated onboarding for new team members

Efficiency Improvements

⏱️ Development Time Comparison [Per Resource (Example: Product CRUD)]

Task	Command	Standard Time Required
Create 4 basic files (Model/Migration/Controller/Factory)	make:model Product -mcf	1 min
Create Seeder	make:seeder ProductSeeder	1 min
Create Request (2 files)	make:request × 2 times	2 min
Create Service	❌ Manual implementation	8 min
Modify migration according to table definition	❌ Manual implementation	10 min
Create CRUD (Service side)	❌ Manual implementation	20 min
Connect CRUD (Controller side)	❌ Manual implementation	10 min
Views (5 files)	❌ Manual implementation	10 min
CSS/JS (4 files each)	❌ Manual implementation	10 min
Blade - CSS/JS integration	❌ Manual implementation	5 min
Routes setup	❌ Manual implementation	5 min
Model relationship setup	❌ Manual implementation	10 min
Validation setup	❌ Manual implementation	10 min
Total	-	Approximately 102 min

Complete the same work in just 5 minutes with these commands!

php artisan lac:scaffold Product     # Main processing
php artisan lac:sync-routes          # Route synchronization
php artisan lac:sync-model-rel       # Relationship synchronization
php artisan lac:sync-validations     # Validation synchronization

Manual implementation time: 102 minutes (approximately 1 hour 40 minutes)
LAC execution time: 5 minutes
Time reduction: Up to 95%

Benefits by Project Scale

Project Scale	Time Saved	Potential Cost Savings (assuming $35/hour)
Small (3 resources)	4.9 hours	$172
Medium (10 resources)	16.2 hours	$567
Large (20 resources)	32.3 hours	$1,131

Calculation Details

Time saved per resource: 97 minutes (approximately 1.62 hours)
- Small (3 resources): 1.62 hours × 3 = 4.9 hours
- Medium (10 resources): 1.62 hours × 10 = 16.2 hours
- Large (20 resources): 1.62 hours × 20 = 32.3 hours

Installation & Usage

For detailed installation instructions and sample code, please check our GitHub README.
👉 Laravel Arsenal Core - README

Installation

composer require lac/toolkit

📦 Package details: https://packagist.org/packages/lac/toolkit

Basic Usage Flow

# 1. Scaffolding process
php artisan lac:scaffold Product

# 2. Various synchronization processes
php artisan lac:sync-routes          # Route synchronization
php artisan lac:sync-model-rel       # Relationship synchronization
php artisan lac:sync-validations     # Validation synchronization

# 3. Data integration process (optional)
php artisan lac:db-template          # Excel template generation
php artisan lac:db-import            # Data import

Conclusion

We hope LAC can help enhance your development workflow and productivity.

📝 Feedback & Requests
We welcome your ideas and suggestions through GitHub Issues.
👉 https://github.com/ChikauKume/laravel-arsenal-core/issues

Thank you for reading! If you found this helpful, we'd appreciate your feedback and engagement.

DEV Community: Chikau Kume

[Laravel] Bidirectional Sync Between Migrations and ER Diagrams for Automated Documentation

Introduction

How to Use

Conclusion

🚀 95% Faster Laravel Development - Meet LAC!

Introduction

What This Tool Can Do

Main Features

Architecture Design Philosophy

Efficiency Improvements

⏱️ Development Time Comparison [Per Resource (Example: Product CRUD)]

Benefits by Project Scale

Calculation Details

Installation & Usage

Installation

Basic Usage Flow

Conclusion