Přejít na hlavní obsah

​
Předpoklady

  • Node.js 24.5+ — Stáhnout
  • Yarn 4 — je součástí Node.js prostřednictvím Corepacku. Povolte jej: corepack enable
  • Docker — Stáhnout. Nutné pro spuštění lokálního serveru Twenty. Přeskočte, pokud už máte Twenty spuštěné jinde.
Vytváření aplikace Twenty má tři fáze. Generátor kostry je spojuje do jediného příkazu pro ideální scénář, ale každá fáze je samostatný koncept — když se něco nepovede, znalost aktuální fáze napoví, co opravit.

​
Fáze 1 — Vytvořte kostru projektu

Vytvořte novou aplikaci ze šablony:
Generátor kostry je neinteraktivní: název adresáře se stane názvem aplikace. Předejte --display-name a --description pro přizpůsobení vygenerovaných metadat (později je můžete také upravit v src/constants/universal-identifiers.ts). Tím se v my-twenty-app/ vytvoří projekt v TypeScriptu se startovacím application-config.ts, výchozí rolí, pracovními postupy CI/CD a integračním testem. Po této fázi: máte na svém počítači zdrojový kód aplikace. Zatím neběží — to je předmětem Fáze 2.

​
Fáze 2 — Spusťte lokální server Twenty

Vaše aplikace potřebuje server Twenty, do kterého se bude synchronizovat. Server je plnohodnotná instance Twenty — UI, GraphQL API, PostgreSQL — běžící lokálně v Dockeru. Váš lokální kód nahrává své definice na tento server, díky čemuž se objeví v UI. Nástroj pro vytváření projektů to spustí za vás: při spuštěném Dockeru stáhne image twentycrm/twenty-app-dev, spustí ji na portu 2020 a autentizuje CLI vůči předpřipravenému demo workspace (tim@apple.dev) — není vyžadováno žádné přihlášení. Chcete-li se místo toho připojit k existujícímu serveru Twenty, předejte --url \<your-server-url>. Vzdálené servery se ověřují pomocí OAuth: otevře se prohlížeč, abyste se mohli přihlásit a kliknout na Authorize, čímž udělíte nástroji CLI přístup k vašemu pracovnímu prostoru. (Můžete se také rozhodnout pro OAuth lokálně pomocí --authentication-method oauth — přihlaste se pomocí tim@apple.dev / tim@apple.dev.)
Přihlašovací obrazovka Twenty
Autorizační obrazovka Twenty CLI
Váš terminál potvrdí, že je vše nastaveno.
Aplikace byla úspěšně vygenerována
Po této fázi: máte spuštěný server Twenty na http://localhost:2020 a vaše CLI má oprávnění se k němu synchronizovat.
Pokud Docker není nainstalovaný nebo neběží, generátor kostry vám sdělí správný příkaz pro spuštění ve vašem operačním systému. Jakmile Docker poběží, můžete pokračovat pomocí yarn twenty docker:start — není potřeba znovu vytvářet kostru.

​
Fáze 3 — Synchronizujte své změny

Toto je vnitřní smyčka, ve které strávíte většinu času.
Tento proces sleduje src/, při každé změně znovu sestaví a synchronizuje výsledek na server. Upravte soubor, uložte a během několika vteřin se změna projeví na serveru. V terminálu uvidíte panel se stavem v reálném čase. Pro podrobnější výstup (protokoly sestavení, požadavky na synchronizaci, stopy chyb) přidejte --verbose.
Výstup terminálu ve vývojovém režimu
Otevřete http://localhost:2020/settings/applications#developer. Vaše aplikace by měla být uvedena v části Your Apps.
Seznam Your Apps se zobrazenou aplikací My twenty app
Klikněte na My twenty app a zobrazí se jeho registrace aplikace — záznam na úrovni serveru, který popisuje vaši aplikaci (název, identifikátor, přihlašovací údaje OAuth, zdroj). Jedna registrace může být nainstalována ve více pracovních prostorech na stejném serveru.
Podrobnosti registrace aplikace
Klikněte na View installed app, abyste zobrazili instalaci v pracovním prostoru. Karta About zobrazuje verzi a možnosti správy.
Nainstalovaná aplikace
Po této fázi: máte průběžný vývojový cyklus. Upravte libovolný soubor v src/ a projeví se to v UI.

​
Jednorázová synchronizace pro CI a skripty

Použijte plan a apply ke spuštění stejné pipeline jednorázově, bez watcheru:
Všechny režimy vyžadují autentizovaný vzdálený server. Více informací o plan najdete v části Synchronizace a obnovení.
yarn twenty dev --once a yarn twenty dev --once --dry-run jsou zastaralé aliasy pro yarn twenty apply a yarn twenty plan.

​
Možnosti vývojového režimu

​
Co můžete vytvořit

Aplikace se skládají z entit — každá je definována jako soubor TypeScriptu s jediným export default: Úplná reference: Koncepty.

​
Další kroky

Konfigurace

Identita aplikace, výchozí role, instalační hooky, veřejná aktiva.

Data

Objekty, pole a obousměrné relace.

Logika

Logické funkce, dovednosti, agenti a připojení přes OAuth.

Rozvržení

Zobrazení, navigace, rozvržení stránek, frontendové komponenty.

Operace

CLI, testování, vzdálené repozitáře, CI a publikování vaší aplikace.