Katkıda Bulunan Kurulumu

Gereksinimler

• Git (Gerekli)
• Node.js v24.16.0 (Gerekli)
• npm v11.16.0 (Zorunlu)
• MongoDB (Zorunlu, veritabanı için)
• Git LFS (Daha büyük dosyalar için kullanışlıdır)
• GitHub Desktop (İsteğe bağlı)
• VSCode (Önerilen Kaynak Kodu Düzenleyicisi)

Önerilen VSCode Eklentileri

VS Code'da şu eklentileri yükleyin:

• Prettier
• ESLint
• GitLens

Ortamı Hazırlayın

Node.js ve npm

nvm kullanıyorsanız, LibreChat'i yüklemeden önce önerilen Node.js sürümünü yükleyin ve seçin:

nvm install 24.16.0
nvm use 24.16.0
npm install -g [email protected]

Kabuğunuzun beklenen sürümleri kullandığını doğrulayın:

node -v
npm -v

v24.16.0
11.16.0

GitHub

• LibreChat deposunu fork'layın: https://github.com/danny-avila/LibreChat/fork

• Çatalınızda (fork) bir dal oluşturun, uygun bir şekilde adlandırın ve orijinal depoya bağlayın.

• Yeni dalınızı yerel bilgisayarınıza indirin

git clone -b branch-name https://github.com/username/LibreChat.git

branch-name ve username kısımlarını kendi bilgilerinizle değiştirin

VS Code'da Aç

• Branşınızı klonladıktan sonra:

  cd LibreChat

  code .

LibreChat'i Hazırlayın

• VS Code'da terminali ctrl+shift+` ile açın.

  Alternatif olarak, alt bölmeyi açmak ve terminali seçmek için ctrl+j tuşlarını kullanın.

• npm run smart-reinstall

  Eğer Node.js veya npm sürümlerini yeni değiştirdiyseniz, temiz bir kurulum için bir kez npm run reinstall komutunu kullanın.

• npm run build

• .env Yapılandırması

  • .env dosyasını oluşturun. Eğer bir tane yoksa, .env.example dosyasını kopyalayın ve yapılandırın.

Geliştirme İş Akışı

LibreChat üzerinde verimli çalışmak için şu komutları kullanın:

• Backend'i Başlatma:

  • Normal çalışma için npm run backend komutunu kullanın.
  • Aktif geliştirme için, değişiklikleri izlemek üzere npm run backend:dev komutunu kullanın.
  • http://localhost:3080/ adresinden erişin.

• Frontend'i Geliştirme Modunda Çalıştırma:

  • Backend'in çalıştığından emin olun.
  • Frontend değişikliklerini izlemek için npm run frontend:dev komutunu kullanın.
  • http://localhost:3090/ adresinden görüntüleyin.

Yerel Test

Gönderimden önce güncellemelerinizi yerel olarak test edin, bkz: Perform Tests Locally

Testleri çalıştırarak katkılarınızın sağlam olduğundan ve entegrasyona hazır olduğundan emin olun.

Commit, Push, Pull Request (PR)

Bir Commit Yapın

Commits, geliştirmedeki mantıksal kontrol noktalarını işaret eder. Değişiklikleri açıklayan net mesajlar ekleyin.

Örnek:

git add .
git commit -m "Add login functionality"

Değişiklikleri Gönder (Push)

Bir özellik tamamlandıktan veya bir sorun giderildikten sonra değişiklikleri uzak depoya Push edin.

Örnek:

git push origin feature-branch-name

Bir Pull Request (PR) Oluşturun

Pull Request, değişiklikleri bir özellik dalından (feature branch) ana dala (main branch) birleştirir.

1. main dalından en son değişiklikleri çekin ve çakışmaları çözün.
2. Güncellenmiş özellik dalını (feature branch) push'layın.
3. Kodun proje yönergelerine uygun olduğundan emin olun.

Örnek:

git checkout main
git pull origin main
git checkout feature-branch-name
git rebase main
# Resolve conflicts if any
git push origin feature-branch-name
# Open PR on GitHub

Deponuzu bir tarayıcıda açın ve "Contribute" düğmesine tıklayın.

Commit'leri Güvenli Bir Şekilde Geri Alma

Bir özellik dalındaki (feature branch) değişiklikleri geri almak için şu adımları dikkatlice izleyin:

• git pull origin feature-branch-name

• git log

• git rebase -i HEAD~N

  Kaldırılacak commit'ler için pick ifadesini drop ile değiştirin. Düzenleyiciyi kaydedip çıkın.

• git push --force-with-lease origin feature-branch-name