Welcome to HkDevs CodeForge Database Studio!
This guide will help you get started with the professional database management solution for Laravel applications. Install and configure your development environment in minutes with our comprehensive toolkit.
System Requirements
Core Requirements
- PHP 8.1 or higher
- Laravel 10.x or higher
- FilamentPHP 3.x
- MySQL 5.7+ / PostgreSQL 11+ / SQLite 3.8+ / SQL Server 2017+
PHP Extensions
- PDO Extension
- JSON Extension
- cURL Extension
- OpenSSL Extension
- DOM Extension (for PDF generation)
Installation
Step 1: Purchase & Download
Purchase your license from our official marketplace and download the complete installation package.
Step 2: Extract Plugin Files
cp -r codeforge-database-studio/ /path/to/your/laravel/packages/
Extract the downloaded package to your Laravel application's packages directory or vendor folder.
Step 3: Run Installation Command
php artisan codeforge:install
This command will publish configuration files, run necessary migrations, and set up the plugin.
Step 4: Configure Your Panel
Add the plugin to your Filament admin panel provider:
use HkDevs\CodeForgeStudio\CodeForgeStudioPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
CodeForgeStudioPlugin::make()
->enableSchemaDesigner()
->enableMigrationManager()
->enableHealthMonitoring()
->enableDevDocs()
->enableSmartSeeding()
->enableDocumentationGenerator()
->enableCodeGeneration(),
]);
}
Configuration
Environment Variables
Add these optional settings to your .env file:
# CodeForge Database Studio Settings CODEFORGE_ENABLE_QUERY_LOGGING=true CODEFORGE_SLOW_QUERY_THRESHOLD=1000 CODEFORGE_ENABLE_HEALTH_MONITORING=true CODEFORGE_ENABLE_SCHEMA_DESIGNER=true CODEFORGE_ENABLE_CODE_GENERATION=true
Configuration File
Customize settings in config/codeforge-database-studio.php:
Feature Toggles
- • Database Overview & Analytics
- • Visual Schema Designer
- • Migration Management
- • Health Monitoring
- • Smart Data Seeding
- • Documentation Generator
- • Code Generation Suite
Performance Settings
- • Query Logging Thresholds
- • Health Metric Collection
- • Performance Monitoring
- • Connection Timeouts
- • Cache Configuration
Initial Setup
Database Connection
Ensure your database connections are properly configured in config/database.php.
'mysql' => [
'driver' => 'mysql',
'host' => env('DB_HOST', '127.0.0.1'),
'port' => env('DB_PORT', '3306'),
'database' => env('DB_DATABASE', 'forge'),
'username' => env('DB_USERNAME', 'forge'),
'password' => env('DB_PASSWORD', ''),
]
User Permissions
Set up user access permissions for database operations:
First Use
Access Dashboard
Visit your Filament admin panel and look for the "CodeForge Database Studio" navigation groups.
https://yourapp.com/admin
Explore Features
- Database Overview
- Visual Schema Designer
- Migration Manager
- Health Monitoring
- Smart Data Seeding
- Documentation Generator
- Code Generation Tools
Essential CLI Commands
Quick Start Commands
Installation
php artisan codeforge:install
Install and configure the plugin
Health Check
php artisan codeforge:collect-metrics
Collect database health metrics
Documentation
php artisan codeforge:generate-docs
Generate database documentation
Data Generation
php artisan codeforge:generate-data
Generate test data intelligently
Pro Tip: Plugin Configuration
Customize which features are enabled in your panel configuration:
CodeForgeStudioPlugin::make()
->enableSchemaDesigner()
->enableMigrationManager()
->enableHealthMonitoring()
->enableSmartSeeding()
->enableDocumentationGenerator()
->enableCodeGeneration()