Update README.md for Citrus Platform: Expanded documentation to include an overview of the platform, technology stack, installation steps, module development guidelines, localization system, testing procedures, deployment instructions, contribution process, coding standards, and licensing information. Enhanced clarity and organization for better developer onboarding.

2025-09-27 15:02:00 -03:00
parent 188066c885
commit a493364e2d
1 changed files with 226 additions and 40 deletions
@@ -1,61 +1,247 @@
-<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
+# Citrus Platform

-<p align="center">
-<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
-</p>
+## Genel Bakış

-## About Laravel
+Citrus Platform, Laravel tabanlı modüler bir platformdur. Türkçe NLP, sınıflandırma, özetleme ve raporlama özelliklerini içeren evrensel bir AI entegrasyon sistemi olarak tasarlanmıştır.

-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
+## Teknoloji Stack

- [Simple, fast routing engine](https://laravel.com/docs/routing).
- [Powerful dependency injection container](https://laravel.com/docs/container).
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
- [Robust background job processing](https://laravel.com/docs/queues).
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
+- **Backend**: Laravel 12.x
+- **Admin Panel**: Filament 3.x
+- **Database**: MySQL/PostgreSQL
+- **Frontend**: Blade Templates + Alpine.js
+- **Localization**: Laravel Localization (TR/EN)
+- **Testing**: PHPUnit

-Laravel is accessible, powerful, and provides tools required for large, robust applications.
+## Kurulum

-## Learning Laravel
+### Gereksinimler
+- PHP 8.2+
+- Composer
+- Node.js 18+
+- MySQL 8.0+ veya PostgreSQL 13+

-Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
+### Adım 1: Projeyi Klonla
+```bash
+git clone <repository-url>
+cd citrus-platform
+```

-You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
+### Adım 2: Bağımlılıkları Yükle
+```bash
+composer install
+npm install
+```

-If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
+### Adım 3: Environment Ayarları
+```bash
+cp .env.example .env
+php artisan key:generate
+```

-## Laravel Sponsors
+### Adım 4: Veritabanı Ayarları
+`.env` dosyasında veritabanı ayarlarını yapın:
+```env
+DB_CONNECTION=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_DATABASE=citrus_platform
+DB_USERNAME=root
+DB_PASSWORD=
+```

-We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
+### Adım 5: Migration ve Seed
+```bash
+php artisan migrate
+php artisan db:seed
+```

-### Premium Partners
+### Adım 6: Storage Link
+```bash
+php artisan storage:link
+```

- **[Vehikl](https://vehikl.com)**
- **[Tighten Co.](https://tighten.co)**
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
- **[64 Robots](https://64robots.com)**
- **[Curotec](https://www.curotec.com/services/technologies/laravel)**
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
- **[Redberry](https://redberry.international/laravel-development)**
- **[Active Logic](https://activelogic.com)**
+### Adım 7: Frontend Build
+```bash
+npm run build
+```

-## Contributing
+## Geliştirme

-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
+### Modül Geliştirme

-## Code of Conduct
+Citrus Platform'da yeni modül geliştirmek için Pages modülünü referans alın:

-In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
+1. **Geliştirici El Kitabı**: `docs/DEVELOPER_HANDBOOK.md`
+2. **Localization Pattern**: `docs/LOCALIZATION_PATTERN.md`
+3. **Modül Template**: `docs/MODULE_TEMPLATE.md`
+4. **Cursor Rules**: `.cursorrules`

-## Security Vulnerabilities
+### Pages Modülü - Örnek Modül

-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
+Pages modülü, platformdaki tüm modüller için referans alınacak örnek modüldür:

-## License
+#### Özellikler
+- ✅ **Localization**: Türkçe ve İngilizce dil desteği
+- ✅ **CRUD Operations**: Oluşturma, okuma, güncelleme, silme
+- ✅ **Soft Delete**: Yumuşak silme özelliği
+- ✅ **Form Validation**: Kapsamlı form doğrulama
+- ✅ **Table Features**: Filtreleme, sıralama, arama
+- ✅ **Action Buttons**: Silme, geri yükleme, kalıcı silme
+- ✅ **Notifications**: Başarı/hata mesajları
+- ✅ **Redirects**: Sayfa yönlendirmeleri

-The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+#### Dosya Yapısı
+```
+app/Filament/Admin/Resources/Pages/
+├── PageResource.php
+├── Pages/
+│   ├── ListPages.php
+│   ├── CreatePage.php
+│   └── EditPage.php
+├── Schemas/
+│   └── PageForm.php
+└── Tables/
+    └── PagesTable.php
+
+lang/
+├── tr/pages.php
+└── en/pages.php
+```
+
+### Localization Sistemi
+
+Platform, Laravel Localization sistemi kullanarak çoklu dil desteği sağlar:
+
+#### Dil Değiştirme
+```php
+use Illuminate\Support\Facades\App;
+
+// Türkçe'ye geç
+App::setLocale('tr');
+
+// İngilizce'ye geç
+App::setLocale('en');
+```
+
+#### Çeviri Kullanımı
+```php
+// Blade template'lerde
+{{ __('pages.title') }}
+
+// Controller'larda
+$title = __('pages.navigation_label');
+```
+
+## Test
+
+### Test Çalıştırma
+```bash
+# Tüm testler
+php artisan test
+
+# Belirli test sınıfı
+php artisan test --filter=PageTest
+
+# Coverage ile
+php artisan test --coverage
+```
+
+### Test Kategorileri
+- **Unit Tests**: Model ve sınıf testleri
+- **Feature Tests**: API ve sayfa testleri
+- **Localization Tests**: Çeviri testleri
+- **Integration Tests**: Sistem entegrasyon testleri
+
+## Deployment
+
+### Production Hazırlığı
+```bash
+# Cache temizleme
+php artisan cache:clear
+php artisan config:clear
+php artisan route:clear
+php artisan view:clear
+
+# Cache oluşturma
+php artisan config:cache
+php artisan route:cache
+php artisan view:cache
+
+# Migration
+php artisan migrate --force
+
+# Storage link
+php artisan storage:link
+```
+
+### Environment Variables
+```env
+# Localization
+APP_LOCALE=tr
+APP_FALLBACK_LOCALE=en
+
+# Cache
+CACHE_DRIVER=redis
+SESSION_DRIVER=redis
+QUEUE_CONNECTION=redis
+
+# Database
+DB_CONNECTION=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_DATABASE=citrus_platform
+DB_USERNAME=root
+DB_PASSWORD=
+```
+
+## Dokümantasyon
+
+### Geliştirici Dokümantasyonu
+- [Geliştirici El Kitabı](docs/DEVELOPER_HANDBOOK.md)
+- [Localization Pattern](docs/LOCALIZATION_PATTERN.md)
+- [Modül Template](docs/MODULE_TEMPLATE.md)
+
+### API Dokümantasyonu
+- [API Endpoints](docs/API.md)
+- [Authentication](docs/AUTHENTICATION.md)
+- [Rate Limiting](docs/RATE_LIMITING.md)
+
+## Katkıda Bulunma
+
+### Geliştirme Süreci
+1. Fork yapın
+2. Feature branch oluşturun (`git checkout -b feature/amazing-feature`)
+3. Değişikliklerinizi commit edin (`git commit -m 'Add amazing feature'`)
+4. Branch'inizi push edin (`git push origin feature/amazing-feature`)
+5. Pull Request oluşturun
+
+### Kod Standartları
+- PSR-12 standartlarına uyun
+- Type hinting kullanın
+- Test yazın
+- Dokümantasyonu güncelleyin
+- Localization kullanın
+
+## Lisans
+
+Bu proje MIT lisansı altında lisanslanmıştır. Detaylar için [LICENSE](LICENSE) dosyasına bakın.
+
+## İletişim
+
+- **Proje Sahibi**: [İsim]
+- **Email**: [email@example.com]
+- **Website**: [https://example.com]
+
+## Changelog
+
+### v1.0.0 (2024-01-01)
+- İlk sürüm
+- Pages modülü eklendi
+- Localization sistemi kuruldu
+- Filament admin panel entegrasyonu
+- Test altyapısı oluşturuldu
+
+---
+
+**Not**: Bu README dosyası, Citrus Platform'un genel yapısını ve kullanımını açıklar. Detaylı geliştirme bilgileri için `docs/` klasöründeki dokümantasyonları inceleyin.