نصب
برای راهاندازی Laravel Scaffolder مراحل زیر را دنبال کنید.
پیشنیازها
- PHP نسخه 8.1 تا 8.5
- لاراول ۱۰ تا ۱۳ (سرویسپرووایدر پکیج بهصورت خودکار شناسایی میشود)
- اتصال پایگاهداده برای اجرای تستهای تولیدشده
- (اختیاری برای Swagger) در صورت استفاده از فلگ
--swagger، یکی از بستههایdarkaonline/l5-swaggerیاzircote/swagger-phpرا نصب کنید.
۱. نصب بسته
composer require efati/laravel-scaffolder
Composer بهصورت خودکار ModuleGeneratorServiceProvider را شناسایی میکند و دستور make:module و ابزارهای پکیج در دسترس قرار میگیرند.
۲. انتشار پیکربندی و کلاسهای کمکی
php artisan vendor:publish
در فهرست تعاملی، ابتدا گزینهٔ Efati\ModuleGenerator\ModuleGeneratorServiceProvider و سپس تگ module-generator را انتخاب کنید. این کار موارد زیر را کپی میکند:
config/module-generator.php– نامفضاها، مسیر خروجی و پیشفرضها را اینجا تنظیم کنید.- کلاسهای پایهٔ سرویس/ریپازیتوری و هِلپر
ApiResponseHelperکه در کنترلرها و ریسورسها استفاده میشود.
انتشار فایلها صریح است؛ صرفاً با نصب پکیج هیچکدام از این فایلها بهصورت خودکار داخل پروژه شما نوشته نمیشوند.
فایل پیکربندی را در مخزن نگه دارید تا همهٔ محیطها ساختار یکسانی داشته باشند.
۳. (اختیاری) انتشار قالبها
php artisan vendor:publish
همان سرویسپرووایدر را انتخاب کنید و این بار تگ module-generator-stubs را برگزینید. قالبها در مسیر resources/stubs/module-generator قرار میگیرند و از این پس جایگزین نسخهٔ بسته میشوند. آنها را ویرایش کنید تا تریتها، لاگ یا استانداردهای نامگذاری سازمان شما اعمال شود.
۴. آمادهسازی محیط
- مطمئن شوید تنظیمات پایگاهداده در
.envصحیح است؛ تستهای فیچری از همین اتصال استفاده میکنند. - اگر قصد شخصیسازی کلاسهای پایه را دارید آنها را در مخزن کامیت کنید تا در اجراهای بعدی در دسترس باشند.
- اگر نسخه یا ساختار اپلیکیشن شما نیاز به ثبت دستی Providerهای تولیدشده دارد، همان ثبت را نیز در کنترل نسخه نگه دارید.
پس از طی این مراحل میتوانید به راهنمای شروع سریع بروید و اولین ماژول خود را بسازید.