Yerel Kurulum

Twenty’i yerel olarak çalıştırmak isteyen katkıda bulunanlar (veya meraklı geliştiriciler) için kılavuz.

​

Ön Gereksinimler

Linux ve macOS

Twenty’i yüklemeden ve kullanmadan önce bilgisayarınıza aşağıdakileri yüklediğinizden emin olun:

• Git
• Node v24.5.0
• yarn v4
• nvm

npm çalışmaz, bunun yerine yarn kullanmalısınız. Yarn artık Node.js ile birlikte geliyor, bu yüzden ayrı bir yüklemeye gerek yoktur. Eğer henüz yapmadıysanız Yarn’ı etkinleştirmek için sadece corepack enable komutunu çalıştırmanız gerekiyor.

Windows (WSL)

1. WSL Kurun PowerShell’i Yönetici olarak açın ve çalıştırın:

wsl --install

Şimdi bilgisayarınızı yeniden başlatmanız gerektiğine dair bir uyarı göreceksiniz. Eğer görmüyorsanız, manuel olarak yeniden başlatın.

Yeniden başlatıldığında bir PowerShell penceresi açılacak ve Ubuntu yüklenecek. Bu biraz zaman alabilir. Ubuntu kurulumunuz için bir kullanıcı adı ve şifre oluşturmanız gerektiğine dair bir uyarı göreceksiniz.

2. git’i Yükleyin ve Yapılandırın

sudo apt-get install git

git config --global user.name "Adınız"

git config --global user.email "[e-mail]"

3. nvm, node.js ve yarn’ı Yükleyin

Doğru node versiyonunu yüklemek için nvm kullanın. .nvmrc tüm katkıda bulunanların aynı versiyonu kullanmasını sağlar.

sudo apt-get install curl

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash

nvm’i kullanmak için terminalinizi kapatıp yeniden açın. Sonra aşağıdaki komutları çalıştırın.

nvm install # önerilen node versiyonunu yükler

nvm use # önerilen node versiyonunu kullan

corepack enable

---

​

Adım 1: Git Clone

Terminalinizde aşağıdaki komutu çalıştırın.

SSH (Önerilen)

SSH anahtarlarını henüz kurmadıysanız, bunu nasıl yapacağınızı buradan öğrenebilirsiniz.

git clone [e-mail]:twentyhq/twenty.git

HTTPS

git clone https://github.com/twentyhq/twenty.git

​

Adım 2: Kök Dizine Konuçlanın

cd twenty

Sonraki adımlardaki tüm komutları projenin kök dizininden çalıştırmalısınız.

​

Adım 3: Bir PostgreSQL Veritabanı Kurun

Linux

Seçenek 1 (tercih edilen): Veritabanınızı yerel olarak hazırlamak için: Linux makinenize PostgreSQL yüklemek için aşağıdaki bağlantıyı kullanın: PostgreSQL Kurulumu

  psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"

Not: İzin hatalarından kaçınmak için psql komutundan önce sudo -u postgres eklemeniz gerekebilir.

Seçenek 2: Eğer docker yüklüyse:

  make -C packages/twenty-docker postgres-on-docker

Mac OS

Seçenek 1 (tercih edilen): Veritabanınızı brew ile yerel olarak kurmak için:

  brew install postgresql@16
  export PATH="/opt/homebrew/opt/postgresql@16/bin:$PATH"
  brew services start postgresql@16
  psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"

PostgreSQL sunucusunun çalışıp çalışmadığını kontrol etmek için şu komutu çalıştırabilirsiniz:

  brew services list

Yükleyici, macOS’ta Homebrew aracılığıyla yüklenirken varsayılan olarak postgres kullanıcısını oluşturmayabilir. Bunun yerine, macOS kullanıcı adınıza (ör. “john”) uygun bir PostgreSQL rolü oluşturur. Gerekiyorsa postgres kullanıcısını kontrol etmek ve oluşturtmak için şu adımları izleyin:

  # PostgreSQL'e Bağlan
  psql postgres
  or
  psql -U $(whoami) -d postgres

psql isteminde (postgres=#) şu komutu çalıştırın:

 # Mevcut PostgreSQL rollerini listeleyin
 \du

Şu benzer bir çıktı göreceksiniz:

 Rol adı | Özellikler  | Üyesi olduğu
 -----------+-------------+-----------
 john      | Superuser   | {}

Eğer listede bir postgres rolü görmüyorsanız, bir sonraki adıma geçin. postgres rolünü manuel olarak oluşturun:

 CREATE ROLE postgres WITH SUPERUSER LOGIN;

Bu, postgres adıyla giriş erişimi olan bir süper kullanıcı rolü oluşturur.

Rol adı | Özellikler  | Üyesi olduğu
-----------+-------------+-----------
postgres  | Superuser   | {}
john      | Superuser   | {}

Seçenek 2: Eğer docker yüklüyse:

  make -C packages/twenty-docker postgres-on-docker

Windows (WSL)

Aşağıdaki tüm adımlar WSL terminalinde (sanallaştırma makineniz içinde) çalıştırılmalıdır.

Seçenek 1: PostgreSQL’i yerel olarak hazırlamak için: Linux sanal makinenize PostgreSQL yüklemek için aşağıdaki bağlantıyı kullanın: PostgreSQL Kurulumu

  psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"

Not: İzin hatalarından kaçınmak için psql komutundan önce sudo -u postgres eklemeniz gerekebilir.

Seçenek 2: Eğer docker yüklüyse: WSL üzerinde Docker çalıştırmak ek bir karmaşıklık katmanı ekler. Yalnızca ek adımlar dahil olmak üzere extra karmaşıklık adımlarına aşinaysanız kullanın. Docker Desktop WSL2 etkinleştirmenizi içeren.

  make -C packages/twenty-docker postgres-on-docker

Artık veritabanına localhost:5432 üzerinden erişebilirsiniz.

Yukarıdaki Docker seçeneğini kullandıysanız, varsayılan kimlik bilgileri kullanıcı adı postgres ve parola postgres şeklindedir. Yerel PostgreSQL kurulumları için, makinenizde yapılandırılmış kimlik bilgilerini ve rolleri kullanın.

​

Adım 4: Redis Veritabanı (önbellek) Kurun

Twenty, en iyi performansı sağlamak için bir Redis önbelleği gerektirir.

Linux

Seçenek 1: Redis’i yerel olarak sağlamak için: Linux makinenize Redis yüklemek için şu bağlantıyı kullanın: Redis Kurulumu

Seçenek 2: Eğer docker yüklüyse:

  make -C packages/twenty-docker redis-on-docker

Mac OS

Seçenek 1 (tercih edilen): Redis’i brew ile yerel olarak sağlamak için:

brew install redis

Redis sunucunuzu başlatın:

brew services start redis

Seçenek 2: Eğer docker yüklüyse:

  make -C packages/twenty-docker redis-on-docker

Windows (WSL)

Seçenek 1: Redis’i yerel olarak sağlamak için: Linux sanal makinenize Redis yüklemek için şu bağlantıyı kullanın: Redis Kurulumu

Seçenek 2: Eğer docker yüklüyse:

  make -C packages/twenty-docker redis-on-docker

Bir istemci GUI’ye ihtiyacınız varsa, Redis Insight (ücretsiz sürüm mevcut) öneriyoruz.

​

Adım 5: Ortam değişkenlerini ayarlayın

Projenizi yapılandırmak için çevresel değişkenler veya .env dosyaları kullanın. Daha fazla bilgi burada.

.env.example dosyalarını /front ve /server içine kopyalayın:

cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env

Çoklu Çalışma Alanı Modu: Varsayılan olarak, Twenty yalnızca bir çalışma alanının oluşturulabildiği tek çalışma alanı modunda çalışır. Çoklu çalışma alanı desteğini etkinleştirmek için (alt alan adına dayalı özellikleri test etmek açısından kullanışlıdır), sunucunuzdaki .env dosyanızda IS_MULTIWORKSPACE_ENABLED=true değerini ayarlayın. Ayrıntılar için Çoklu Çalışma Alanı Modu bölümüne bakın.

​

Adım 6: Bağımlılıkların yüklenmesi

Twenty server’ı oluşturup veritabanınıza bazı veriler yerleştirmek için aşağıdaki komutu çalıştırın:

yarn

npm veya pnpm çalışmaz

​

Adım 7: Projeyi çalıştırma

Linux

Dağıtımınıza bağlı olarak, Redis sunucusu otomatik olarak başlatılabilir. Değilse, dağıtımınız için Redis Kurulum Kılavuzu üzerinden kontrol edin.

Mac OS

Redis zaten çalışıyor olmalıdır. Değilse, şu komutu çalıştırın:

brew services start redis

Windows (WSL)

Dağıtımınıza bağlı olarak, Redis sunucusu otomatik olarak başlatılabilir. Değilse, dağıtımınız için Redis Kurulum Kılavuzu üzerinden kontrol edin.

Veritabanınızı aşağıdaki komutla kurun:

npx nx database:reset twenty-server

Sunucuyu, çalışanı ve ön uç hizmetlerini başlatın:

npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front

Alternatif olarak, tüm hizmetleri aynı anda başlatabilirsiniz:

npx nx start

​

Adım 8: Twenty’yi kullanın

Ön Uç

Twenty’nin ön ucu http://localhost:3001 adresinde çalışıyor olacak. Varsayılan demo hesabıyla giriş yapabilirsiniz: [e-mail] (şifre: [e-mail])

Arka Uç

• Twenty’nin sunucusu http://localhost:3000 adresinde çalışır durumda olacak
• GraphQL API’sine http://localhost:3000/graphql adresinden erişebilirsiniz.
• REST API’sine http://localhost:3000/rest adresinden ulaşabilirsiniz.

​

Sorun Giderme

Herhangi bir sorunla karşılaşırsanız, çözümler için Sorun Giderme sayfasına bakın.