From 963e0accc980ebb8e6a90891521a941e174c797d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=9Cmit=20Tun=C3=A7?= Date: Wed, 29 Apr 2026 06:03:17 +0300 Subject: [PATCH] docs: update installation and configuration instructions in README --- README.md | 63 +++++++++++++++++++++++++------------------------------ 1 file changed, 28 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index c59120d..1a2e264 100644 --- a/README.md +++ b/README.md @@ -380,7 +380,29 @@ $relationDatas = [ ## Yeni Modül Geliştirme -Yeni bir modül geliştirmek için aşağıdaki adımları takip etmeniz gerekir: +Citrus CMS'de yeni bir modül oluşturmak için iki yöntem bulunmaktadır: **Module Generator Wizard** (Önerilen) ve **Manuel Yöntem**. + +### 1. Module Generator Wizard (Önerilen) + +Sistemde bulunan "Module Generator" sihirbazı, bir modül için gerekli olan tüm dosyaları ve veritabanı işlemlerini otomatik olarak gerçekleştirir. + +**Adımlar:** +1. Sol menüden **İçerik Yönetimi (Content Management) > Module Generator** sayfasına gidin. +2. **Temel Bilgiler:** Modül başlığını girin ve bir ikon (PNG) yükleyin. +3. **Veritabanı Sütunları:** Modülde yer alacak alanları tanımlayın: + - Sütun adı, veri tipi (String, Integer, Long Text, Date, Boolean vb.) seçin. + - Açılır menüler (Select) veya API bağlantılı listeler (API Dropdown) için gelişmiş ayarları yapın. +4. **Onay ve Oluştur:** "Generate Module Now" butonuna tıkladığınızda sistem şunları otomatik yapar: + - Veritabanı Migration dosyasını oluşturur ve çalıştırır. + - Eloquent Model dosyasını (`app/Models/`) oluşturur. + - Gelişmiş Datagrid içeren Blade View dosyasını (`resources/views/admin/type/`) oluşturur. + - `types` tablosuna gerekli kaydı ekler. + +Bu işlemden sonra modülünüz hemen kullanıma hazır hale gelir. + +### 2. Manuel Yöntem + +Daha özel ihtiyaçlar için modülü manuel olarak da oluşturabilirsiniz: 1. **Model ve Migration Oluşturun**: ```php @@ -411,43 +433,14 @@ Yeni bir modül geliştirmek için aşağıdaki adımları takip etmeniz gerekir ``` 2. **Şablonu Kopyalayın ve Özelleştirin**: - - `resources/views/admin/type/` dizini altında yeni bir blade dosyası oluşturun - - `sablon4.blade.php` temel alınarak özelleştirme yapabilirsiniz - ```php - paginate(setting('row_count')); - $tableName = "yeni_modul"; - - $blockGroup = [ - 'Genel Bilgiler' => [ - 'ad', - 'aciklama', - ], - // Diğer gruplar... - ]; - - $firstUploadFolder = 'YeniModul/'; - $firstUploadTitle = 'Dosya Yükle'; - ?> - -
-
- @include("admin.type.document.upload") - @include("components.blocks.module-block") -
-
- ``` - 3. **Type Tablosuna Kayıt Ekleyin**: - - Admin panelinden yeni bir tip ekleyin - - Modül için gerekli alanları belirtin - - URL adresi olarak oluşturduğunuz şablonu belirtin + - Admin panelinden **Modüller** sayfasına gidin ve yeni bir kayıt ekleyin. + - `Slug` kısmına oluşturduğunuz blade dosyasının adını yazın. -**Önemli Not**: Citrus CMS'de yeni bir modül oluşturmak için genellikle model ve migration oluşturmak, ardından `sablon4.blade.php` şablonunu özelleştirmek yeterlidir. Tüm CRUD işlemleri otomatik olarak `AdminController.php` üzerinden yönetilir ve özel bir controller kodlamanıza gerek yoktur. +**Önemli Not**: Tüm CRUD işlemleri otomatik olarak `AdminController.php` üzerinden yönetilir. Özel bir controller kodlamanıza genellikle gerek yoktur. ## Middleware ve İzin Sistemi