Předpoklady
- Node.js 24+ — 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.
| Fáze | Co děláte | Nástroj | Výsledek |
|---|---|---|---|
| 1. Vytvořit kostru | Vygenerovat zdrojový kód aplikace | npx create-twenty-app | Projekt v TypeScriptu na disku |
| 2. Spustit server | Spustit server Twenty, do kterého se bude synchronizovat | Docker + yarn twenty server | Běžící instance Twenty |
| 3. Synchronizovat | Živě synchronizovat kód na server | yarn twenty dev | Vaše změny se objeví v uživatelském rozhraní |
Fáze 1 — Vytvořte kostru projektu
Vytvořte novou aplikaci ze šablony:my-twenty-app/ vytvoří projekt v TypeScriptu se startovacím application-config.ts, výchozí rolí, CI workflow 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. Generátor kostry nabídne, že vám jej spustí:Chcete nastavit lokální instanci Twenty?
- Ano (doporučeno) — stáhne Docker image
twentycrm/twenty-app-deva spustí jej na portu2020. Nejprve se ujistěte, že Docker běží. - Ne — zvolte, pokud už máte server Twenty, ke kterému se chcete připojit. Můžete jej propojit později pomocí
yarn twenty remote:add.
- E-mail:
tim@apple.dev - Heslo:
tim@apple.dev
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.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.
src/ a projeví se to v UI.
Jednorázová synchronizace pro CI a skripty
Předejte--once pro provedení jednoho sestavení + synchronizace a ukončení — stejný postup, bez sledování změn:
| Příkaz | Chování | Kdy použít |
|---|---|---|
yarn twenty dev | Sleduje změny a při každé změně znovu synchronizuje. Běží, dokud jej nezastavíte. | Interaktivní lokální vývoj. |
yarn twenty dev --once | Jedno sestavení + synchronizace, ukončí se s kódem 0 při úspěchu, 1 při chybě. | CI, pre-commit hooky, AI agenti, skriptované pracovní postupy. |
yarn twenty dev --once --dry-run | Sestaví a vypíše změny metadat bez jejich použití. | Kontrola toho, co by synchronizace změnila, ještě před jejím potvrzením. |
--dry-run najdete v části Synchronizace a obnovení.
Možnosti vývojového režimu
| Přepínač | Popis |
|---|---|
--once | Jednou sestavit a synchronizovat, poté ukončit. |
--dry-run | Pomocí --once zobrazíte náhled změn metadat, aniž byste je použili. Nic nezapisuje. |
--debounceMs \<ms> | Nastaví prodlevu pro potlačení zákmitů při změnách souborů v milisekundách (výchozí: 2000). |
--verbose / --debug | Zobrazí podrobné protokoly sestavení, požadavky synchronizace a trasování chyb. |
Co můžete vytvořit
Aplikace se skládají z entit — každá je definována jako soubor TypeScriptu s jedinýmexport default:
| Entita | K čemu slouží |
|---|---|
| Objekty a pole | Vlastní datové modely (pohlednice, faktura apod.) s typovanými poli |
| Logické funkce | Serverový TypeScript spouštěný HTTP trasami, plánovačem cron nebo událostmi databáze |
| Frontendové komponenty | Komponenty Reactu, které se vykreslují v uživatelském rozhraní Twenty (postranní panel, widgety, příkazová nabídka) |
| Dovednosti a agenti | Schopnosti AI — opakovaně použitelné pokyny a autonomní asistenti |
| Pohledy a navigace | Předkonfigurované seznamové pohledy a položky postranní nabídky |
| Rozvržení stránek | Vlastní stránky detailu záznamu s kartami a widgety |
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.