SigortaCu - Sigorta Yönetim Sistemi

SigortaCu, acentelerin poliçelerini, müşterilerini ve varlıklarını yönetmelerine olanak tanıyan modern, platformlar arası bir uygulamadır. Flutter ile geliştirilen ön uç, PHP tabanlı bir REST API ile iletişim kurar.

Proje Durumu

Bu proje şu anda üretim seviyesine getirilmek üzere aktif olarak geliştirilmektedir. Mevcut odak, temel altyapıyı (veritabanı, kimlik doğrulama, CI/CD) sağlamlaştırmak ve kod kalitesini artırmaktır. Detaylı yol haritası için ROADMAP.md dosyasına bakın.

Teknolojiler

• Frontend: Flutter
• Backend: PHP (REST API)
• Database: MySQL
• Database Migrations: Phinx
• Testing: PHPUnit (Backend), Flutter Test (Frontend)
• CI: GitHub Actions

---

Kurulum ve Geliştirme Ortamı

Bu projeyi yerel makinenizde kurmak ve çalıştırmak için aşağıdaki adımları izleyin.

Önkoşullar

• Flutter SDK: Resmi kurulum kılavuzu
• PHP: >= 8.0
• Composer: Resmi kurulum kılavuzu
• MySQL: Veya MariaDB gibi uyumlu bir veritabanı sunucusu.
• Git

1. Projeyi Klonlama

git clone https://github.com/Yamac/Sigortacu.git
cd SigortaCu

2. Docker ile Yerel Geliştirme (Önerilen)

Bu proje, PHP ve MySQL için yapılandırılmış bir Docker ortamı içerir. Bu, en hızlı ve en güvenilir kurulum yöntemidir.

a. Ortam Değişkenlerini Ayarlama

.env.example dosyasını kopyalayarak başlayın.

cp .env.example .env

.env dosyasını açıp içindeki değerleri (özellikle PHP_PASSWORD ve JWT_SECRET_KEY) güvenli değerlerle değiştirebilirsiniz, ancak varsayılanlar yerel geliştirme için çalışacaktır.

b. Docker Servislerini Başlatma

docker-compose up -d --build

Bu komut, PHP ve MySQL servislerini arka planda başlatacaktır.

c. Bağımlılıkları Yükleme ve Veritabanını Hazırlama

Docker container'ı içinde composer install ve Phinx komutlarını çalıştırın.

# Composer bağımlılıklarını yükle
docker-compose exec php composer install

# Veritabanı şemasını oluştur (migrations)
docker-compose exec php vendor/bin/phinx migrate

# Veritabanını başlangıç verileriyle doldur (seeding)
docker-compose exec php vendor/bin/phinx seed:run -s UserSeeder

Artık backend API'niz http://localhost adresinde çalışıyor.

3. Manuel Yerel Geliştirme

Eğer Docker kullanmıyorsanız, aşağıdaki adımları izleyebilirsiniz.

a. Backend Kurulumu

Backend, PHP tabanlı bir REST API'dir.

a. Bağımlılıkları Yükleme

Proje, veritabanı migration'ları ve testler için Composer kullanır.

composer install

b. Ortam Yapılandırması

Veritabanı bağlantısı ve güvenlik anahtarları için bir yapılandırma dosyası oluşturmanız gerekir.

cp backend/config.example.php backend/config.php

Şimdi backend/config.php dosyasını açın ve yerel veritabanı ayarlarınızla (DB_HOST, DB_USER, DB_PASS, DB_NAME) güncelleyin. JWT_SECRET_KEY için de güvenli bir anahtar belirleyin.

c. Veritabanını Hazırlama (Migrations)

Veritabanı şeması Phinx ile yönetilmektedir. Veritabanını oluşturmak ve en son şemaya getirmek için aşağıdaki komutu çalıştırın:

vendor/bin/phinx migrate

d. Veritabanını Doldurma (Seeding)

Uygulamaya giriş yapabilmek için varsayılan bir kullanıcı oluşturun:

vendor/bin/phinx seed:run -s UserSeeder

Bu komut, aşağıdaki kimlik bilgileriyle bir kullanıcı oluşturur:

• Kullanıcı adı: admin
• Şifre: password

3. Frontend Kurulumu

Frontend, Flutter ile geliştirilmiştir.

a. Bağımlılıkları Yükleme

flutter pub get

b. Uygulamayı Çalıştırma

Bir emülatör veya bağlı bir cihaz üzerinde uygulamayı çalıştırın:

flutter run

c. API Bağlantısını Yapılandırma

Uygulama ilk açıldığında, sizi Login ekranına yönlendirecektir. Ancak, uygulamanın backend'inize bağlanabilmesi için Ayarlar sayfasından API adresini yapılandırmanız gerekebilir.

• Uygulama içindeki Ayarlar menüsüne gidin.
• API Base URL alanına yerel PHP sunucunuzun adresini girin (örn: http://localhost:8000).
• Ayarları kaydedin.

4. Testleri Çalıştırma

a. Backend Testleri (PHPUnit)

vendor/bin/phpunit

b. Frontend Testleri (Flutter)

flutter test

---

Katkıda Bulunma

Katkılarınız memnuniyetle karşılanır! Lütfen ROADMAP.md dosyasını inceleyin ve bir issue açarak veya mevcut bir issue üzerinde çalışarak katkıda bulunun.

1. Projeyi fork'layın.
2. Yeni bir feature branch oluşturun (git checkout -b feature/YeniOzellik).
3. Değişikliklerinizi commit'leyin (git commit -m 'Yeni bir özellik eklendi').
4. Branch'inizi push'layın (git push origin feature/YeniOzellik).
5. Bir Pull Request açın.

Lisans

Bu proje MIT Lisansı altında lisanslanmıştır. Detaylar için LICENSE dosyasına bakın.