Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://docs.twenty.com/llms.txt

Use this file to discover all available pages before exploring further.

Ön Gereksinimler

  • Node.js 24+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şamaNe yaparsınızAraçSonuç
1. İskelet OluşturmaUygulamanın kaynak kodunu oluşturunnpx create-twenty-appDiskte bir TypeScript projesi
2. Bir sunucu çalıştırmaEşitleme yapacağınız bir Twenty sunucusu başlatınDocker + yarn twenty serverÇalışan bir Twenty örneği
3. EşitlemeKodunuzu sunucuya canlı olarak eşitleyinyarn twenty devDeğişiklikleriniz arayüzde görünür

Aşama 1 — Projenizin iskeletini oluşturun

Şablondan yeni bir uygulama oluşturun:
npx create-twenty-app@latest my-twenty-app
Sizden bir ad ve açıklama istenir — varsayılanlar için Enter tuşuna basın. Bu, my-twenty-app/ içinde bir başlangıç application-config.ts, varsayılan bir rol, bir CI iş akışı 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. İskelet oluşturucu sizin için bir tane başlatmayı teklif eder:
Yerel bir Twenty örneği kurmak ister misiniz?
  • Evet (önerilir)twentycrm/twenty-app-dev Docker imajını çeker ve 2020 portunda başlatır. Önce Docker’ın çalıştığından emin olun.
  • Hayır — Zaten bağlanmak istediğiniz bir Twenty sunucunuz varsa bunu seçin. Bunu daha sonra yarn twenty remote add ile bağlayabilirsiniz.
Yerel örnek başlatılsın mı?
Sunucu çalışır duruma geldiğinde, oturum açmak için bir tarayıcı açılır. Önceden eklenmiş demo hesabını kullanın:
  • E-posta: tim@apple.dev
  • Parola: tim@apple.dev
Twenty oturum açma ekranı
Sonraki ekranda Authorize’a tıklayın — bu işlem CLI’nin çalışma alanınıza erişmesine izin verir.
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 server 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.
cd my-twenty-app
yarn twenty dev
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

Tek bir derleme + eşitleme çalıştırıp çıkmak için --once parametresini geçin — aynı ardışık düzen, izleyici yok:
yarn twenty dev --once
KomutDavranışNe zaman kullanılmalı
yarn twenty devHer değişiklikte izler ve yeniden eşitler. Siz durdurana kadar çalışır.Etkileşimli yerel geliştirme.
yarn twenty dev --onceTek derleme + eşitleme; başarıda 0, başarısızlıkta 1 ile çıkar.CI, pre-commit kancaları, AI ajanları, betiklenmiş iş akışları.
Her iki kipin de kimliği doğrulanmış bir uzak sunucuya ihtiyaç duyar.

Geliştirme kipi seçenekleri

BayrakAçıklama
--onceBir kez derleyip eşitleyin, ardından çıkın.
--debounceMs \<ms>Dosya değişikliği geciktirme süresini milisaniye cinsinden ayarlayın (varsayılan: 2000).
--verbose / --debugAyrıntılı derleme günlüklerini, eşitleme isteklerini ve hata izlerini gösterin.

Bir örnekten başlayın

Daha kapsamlı bir projeyle başlamak için --example kullanın (özel nesneler, alanlar, mantık işlevleri, ön uç bileşenleri):
npx create-twenty-app@latest my-twenty-app --example postcard
Örnekler twenty-apps/examples dizininde yer alır. Ayrıca yarn twenty add ile mevcut bir projeye tek tek varlıklar için iskelet oluşturabilirsiniz — bkz. İskelet Oluşturma.

Oluşturabilecekleriniz

Uygulamalar varlıklardan oluşur — her biri tek bir export default içeren bir TypeScript dosyası olarak tanımlanır:
VarlıkNe yapar
Nesneler ve AlanlarÖzel veri modelleri (Post Card, Invoice vb.) tiplendirilmiş alanlarla
Mantıksal işlevlerHTTP rotaları, cron zamanlamaları veya veritabanı olayları tarafından tetiklenen sunucu tarafı TypeScript
Ön uç bileşenleriTwenty’nin arayüzünde görüntülenen React bileşenleri (yan panel, widget’lar, komut menüsü)
Beceriler ve AracılarYapay zeka yetenekleri — yeniden kullanılabilir yönergeler ve otonom asistanlar
Görünümler ve GezinmeÖnceden yapılandırılmış liste görünümleri ve kenar çubuğu menü öğeleri
Sayfa düzenleriSekmeler ve widget’lar içeren özel kayıt ayrıntı sayfaları
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.