Ana içeriğe atla

Ön Gereksinimler

  • Node.js 24.5+Buradan indirin
  • Yarn 4 — Corepack aracılığıyla Node ile birlikte gelir. Etkinleştirin: corepack enable
  • DockerBuradan indirin. Yerel bir Twenty sunucusunu çalıştırmak için gereklidir. Zaten başka bir yerde Twenty çalıştırıyorsanız atlayın.
Bir Twenty uygulaması oluşturmanın üç aşaması vardır. İskelet oluşturucu bunları tek bir sorunsuz akış komutuna indirger, ancak her aşama ayrı bir kavramdır — bir şeyler başarısız olduğunda hangi aşamada olduğunuzu bilmek neyi düzeltmeniz gerektiğini söyler.

Aşama 1 — Projenizin iskeletini oluşturun

Şablondan yeni bir uygulama oluşturun:
İskele oluşturucu etkileşimsizdir: dizin adı uygulama adı olur. Oluşturulan üstveriyi özelleştirmek için --display-name ve --description parametrelerini iletin (bunu daha sonra src/constants/universal-identifiers.ts içinde de düzenleyebilirsiniz). Bu, my-twenty-app/ içinde bir başlangıç application-config.ts, varsayılan bir rol, CI/CD iş akışları ve bir entegrasyon testi ile bir TypeScript projesi oluşturur. Bu aşamadan sonra: makinenizde uygulamanın kaynak kodu bulunur. Henüz çalışmıyor — bu, 2. Aşama.

Aşama 2 — Yerel bir Twenty sunucusu çalıştırın

Uygulamanızın eşitleme yapacağı bir Twenty sunucusuna ihtiyacı vardır. Sunucu, Docker içinde yerel olarak çalışan tam bir Twenty örneğidir — UI, GraphQL API, PostgreSQL. Yerel kodunuz tanımlarını bu sunucuya yükler; bu da onların arayüzde görünmesini sağlar. İskele oluşturucu bunu sizin için başlatır: Docker çalışırken twentycrm/twenty-app-dev imajını çeker, onu 2020 portunda başlatır ve CLI’yı önceden doldurulmuş demo çalışma alanına (tim@apple.dev) karşı kimlik doğrular — oturum açmanız gerekmez. Bunun yerine mevcut bir Twenty sunucusuna bağlanmak için --url \<your-server-url> parametresini iletin. Uzak sunucular OAuth ile kimlik doğrular: oturum açabilmeniz ve Authorize’a tıklayabilmeniz için bir tarayıcı açılır; bu, CLI’ye çalışma alanınıza erişim sağlar. (Yerelde de --authentication-method oauth ile OAuth kullanmayı tercih edebilirsiniz — tim@apple.dev / tim@apple.dev ile oturum açın.)
Twenty oturum açma ekranı
Twenty CLI yetkilendirme ekranı
Terminaliniz her şeyin kurulduğunu onaylayacaktır.
Uygulama iskeleti başarıyla oluşturuldu
Bu aşamadan sonra: http://localhost:2020 adresinde çalışan bir Twenty sunucunuz ve ona eşitleme yapmak için yetkilendirilmiş bir CLI’ınız olur.
Docker yüklü değilse veya çalışmıyorsa, iskelet oluşturucu işletim sisteminiz için doğru başlatma komutunu söyleyecektir. Docker çalışır duruma geldiğinde, yarn twenty docker:start ile devam edebilirsiniz — yeniden iskelet oluşturmaya gerek yok.

Aşama 3 — Değişikliklerinizi eşitleyin

Zamanınızın çoğunu geçireceğiniz iç döngü budur.
Bu, src/ dizinini izler, her değişiklikte yeniden oluşturur ve sonucu sunucuya eşitler. Bir dosyayı düzenleyin, kaydedin ve birkaç saniye içinde sunucu değişikliği yansıtır. Terminalinizde canlı bir durum paneli göreceksiniz. Daha ayrıntılı çıktı (derleme günlükleri, eşitleme istekleri, hata izleri) için --verbose ekleyin.
Geliştirme modu terminal çıktısı
http://localhost:2020/settings/applications#developer adresini açın. Uygulamanızı Your Apps altında görmelisiniz.
Your Apps listesinde My twenty app gösteriliyor
My twenty app’e tıklayarak uygulama kaydını görüntüleyin — uygulamanızı tanımlayan (ad, tanımlayıcı, OAuth kimlik bilgileri, kaynak) sunucu düzeyinde bir kayıttır. Tek bir kayıt, aynı sunucudaki birden çok çalışma alanına kurulabilir.
Uygulama kaydı ayrıntıları
Çalışma alanındaki kurulumu görmek için View installed app’e tıklayın. About sekmesi sürümü ve yönetim seçeneklerini gösterir.
Yüklü uygulama
Bu aşamadan sonra: canlı bir geliştirme döngünüz olur. src/ içindeki herhangi bir dosyayı düzenleyin; arayüzde görünür.

CI ve betikler için tek seferlik eşitleme

Bir izleyici olmadan aynı boru hattını bir kez çalıştırmak için plan ve apply komutlarını kullanın:
Tüm kiplerin kimliği doğrulanmış bir uzak sunucuya ihtiyacı vardır. plan hakkında daha fazla bilgi için Senkronizasyon ve kurtarma bölümüne bakın.
yarn twenty dev --once ve yarn twenty dev --once --dry-run, yarn twenty apply ve yarn twenty plan için kullanımdan kaldırılmış takma adlardır.

Geliştirme kipi seçenekleri

Oluşturabilecekleriniz

Uygulamalar varlıklardan oluşur — her biri tek bir export default içeren bir TypeScript dosyası olarak tanımlanır: Tam başvuru: Kavramlar.

Sonraki adımlar

Yapılandırma

Uygulama kimliği, varsayılan rol, kurulum kancaları, genel varlıklar.

Veri

Nesneler, alanlar ve çift yönlü ilişkiler.

Mantık

Mantık işlevleri, beceriler, aracılar ve OAuth bağlantıları.

Düzen

Görünümler, gezinme, sayfa düzenleri, ön uç bileşenleri.

İşlemler

CLI, test, uzak uçlar, CI ve uygulamanızı yayımlama.