From 956b2ade61c2fc36298872ddcfe9a4e52564064e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=9Cmit=20Tun=C3=A7?= Date: Wed, 29 Apr 2026 07:36:34 +0300 Subject: [PATCH] docs: update project documentation in README.md --- README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 54 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1a2e264..45530e3 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,18 @@ ## İçindekiler 1. [Proje Genel Bakış](#proje-genel-bakış) -2. [Klasör Yapısı](#klasör-yapısı) -3. [Modül Sistemi](#modül-sistemi) -4. [Kimlik Doğrulama (Auth) Sistemi](#kimlik-doğrulama-auth-sistemi) -5. [Types Tablosu ve Kullanımı](#types-tablosu-ve-kullanımı) -6. [Controller Yapısı](#controller-yapısı) -7. [Helper Fonksiyonlar](#helper-fonksiyonlar) -8. [DevExtreme Entegrasyonu](#devextreme-entegrasyonu) -9. [Admin-AJAX Sistemi](#admin-ajax-sistemi) -10. [Şablonlar ve Bileşenler](#şablonlar-ve-bileşenler) -11. [Yeni Modül Geliştirme](#yeni-modül-geliştirme) -12. [Middleware ve İzin Sistemi](#middleware-ve-izin-sistemi) +2. [Kurulum](#kurulum) +3. [Klasör Yapısı](#klasör-yapısı) +4. [Modül Sistemi](#modül-sistemi) +5. [Kimlik Doğrulama (Auth) Sistemi](#kimlik-doğrulama-auth-sistemi) +6. [Types Tablosu ve Kullanımı](#types-tablosu-ve-kullanımı) +7. [Controller Yapısı](#controller-yapısı) +8. [Helper Fonksiyonlar](#helper-fonksiyonlar) +9. [DevExtreme Entegrasyonu](#devextreme-entegrasyonu) +10. [Admin-AJAX Sistemi](#admin-ajax-sistemi) +11. [Şablonlar ve Bileşenler](#şablonlar-ve-bileşenler) +12. [Yeni Modül Geliştirme](#yeni-modül-geliştirme) +13. [Middleware ve İzin Sistemi](#middleware-ve-izin-sistemi) ## Proje Genel Bakış @@ -26,6 +27,48 @@ Bu proje, Laravel framework'ü üzerine inşa edilmiş, Trunçgil Teknoloji tara - Çoklu dil desteği - Çeşitli helper fonksiyonlar +## Kurulum + +Projeyi yerel ortamınızda ayağa kaldırmak için aşağıdaki adımları izleyin: + +1. **Bağımlılıkları Yükleyin:** + ```bash + composer install + ``` + +2. **Yapılandırma Dosyasını Hazırlayın:** + `.env.example` dosyasını `.env` olarak kopyalayın ve veritabanı bilgilerinizi düzenleyin. + ```bash + cp .env.example .env + ``` + +3. **Uygulama Anahtarını Oluşturun:** + ```bash + php artisan key:generate + ``` + +4. **Veritabanı Migrasyonlarını Çalıştırın:** + ```bash + php artisan migrate + ``` + +### Admin Hesabı Oluşturma ve Şifre Üretme + +Sisteme giriş yapabilmek için bir admin hesabı oluşturmanız veya mevcut admin hesabının şifresini sıfırlamanız gerekebilir. Bunun için özel bir Artisan komutu mevcuttur: + +```bash +php artisan admin:create +``` + +Bu komutu çalıştırdığınızda: +- `admin@citrus.com` e-posta adresi ile bir kullanıcı oluşturulur (varsa şifresi sıfırlanır). +- 12 karakterli rastgele ve güvenli bir şifre üretilir. +- Kullanıcıya tam yetki (`ALL PRIVILEGES`) tanımlanır. +- Üretilen giriş bilgileri terminal ekranında görüntülenir. + +> [!IMPORTANT] +> Güvenlik nedeniyle, üretim (production) ortamında admin şifresini oluşturduktan sonra bu bilgileri güvenli bir yerde saklamanız ve gerekirse panel üzerinden değiştirmeniz önerilir. + ## Klasör Yapısı Projenin ana klasör yapısı Laravel'in standart yapısına uygundur, ancak bazı özel klasör ve dosyalar eklenmiştir: