Skip to main content

Cerințe

  • Node.js 24.5+Descărcați
  • Yarn 4 — vine împreună cu Node prin Corepack. Activați-l: corepack enable
  • DockerDescărcați. Necesar pentru a rula un server Twenty local. Omiteți dacă rulați deja Twenty în altă parte.
Crearea unei aplicații Twenty are trei faze. Generatorul le reunește într-o singură comandă pe calea optimă, dar fiecare fază este un concept separat — când ceva eșuează, dacă știți în ce fază sunteți, știți ce trebuie să corectați.

Faza 1 — Creați scheletul proiectului

Creați o nouă aplicație din șablon:
Generatorul este neinteractiv: numele directorului devine numele aplicației. Transmite --display-name și --description pentru a personaliza metadatele generate (le poți edita și mai târziu în src/constants/universal-identifiers.ts). Aceasta generează un proiect TypeScript în my-twenty-app/ cu un fișier inițial application-config.ts, un rol implicit, fluxuri de lucru CI/CD și un test de integrare. După această fază: aveți codul sursă al aplicației pe mașina dvs. Încă nu rulează — aceasta este Faza 2.

Faza 2 — Rulați un server Twenty local

Aplicația are nevoie de un server Twenty cu care să se sincronizeze. Serverul este o instanță Twenty completă — UI, API GraphQL, PostgreSQL — care rulează local în Docker. Codul local încarcă definițiile pe acel server, făcându-le să apară în UI. Generatorul de proiecte pornește unul pentru tine: cu Docker rulând, descarcă imaginea twentycrm/twenty-app-dev, o pornește pe portul 2020 și autentifică CLI-ul față de spațiul de lucru demo preconfigurat (tim@apple.dev) — fără a fi necesară autentificarea. Pentru a te conecta în schimb la un server Twenty existent, treci argumentul --url \<your-server-url>. Serverele la distanță se autentifică prin OAuth: se deschide un browser astfel încât să te poți autentifica și să dai clic pe Authorize, ceea ce oferă CLI-ului acces la spațiul tău de lucru. (Poți opta pentru OAuth și local cu --authentication-method oauth — autentifică-te cu tim@apple.dev / tim@apple.dev.)
Ecranul de autentificare Twenty
Ecranul de autorizare Twenty CLI
Terminalul va confirma că totul este configurat.
Aplicația a fost creată cu succes
După această fază: aveți un server Twenty care rulează la http://localhost:2020, iar CLI-ul dvs. este autorizat să sincronizeze cu acesta.
Dacă Docker nu este instalat sau nu rulează, generatorul de schelet vă va indica comanda corectă de pornire pentru sistemul dvs. de operare. După ce Docker rulează, puteți continua cu yarn twenty docker:start — nu este nevoie să recreați scheletul.

Faza 3 — Sincronizați modificările

Aceasta este bucla internă în care veți petrece cea mai mare parte a timpului.
Aceasta monitorizează src/, reconstruiește la fiecare modificare și sincronizează rezultatul pe server. Editați un fișier, salvați, iar în câteva secunde serverul reflectă modificarea. Veți vedea în terminal un panou de stare în timp real. Pentru o ieșire mai detaliată (jurnale de build, cereri de sincronizare, urme ale erorilor), adăugați --verbose.
Ieșirea terminalului în modul de dezvoltare
Deschideți http://localhost:2020/settings/applications#developer. Ar trebui să vedeți aplicația dvs. listată la Your Apps.
Lista Your Apps care afișează My twenty app
Faceți clic pe My twenty app pentru a vedea înregistrarea aplicației — o înregistrare la nivel de server care descrie aplicația dvs. (nume, identificator, credențiale OAuth, sursă). O singură înregistrare poate fi instalată în mai multe spații de lucru pe același server.
Detalii despre înregistrarea aplicației
Faceți clic pe View installed app pentru a vedea instalarea în spațiul de lucru. Fila About afișează versiunea și opțiunile de administrare.
Aplicație instalată
După această fază: aveți o buclă de dezvoltare în timp real. Editați orice fișier în src/ și acesta apare în UI.

Sincronizare unică pentru CI și scripturi

Folosește plan și apply pentru a rula același pipeline o singură dată, fără watcher:
Toate modurile necesită o conexiune la distanță autentificată. Vezi Sincronizare și recuperare pentru mai multe detalii despre plan.
yarn twenty dev --once și yarn twenty dev --once --dry-run sunt aliasuri depreciate pentru yarn twenty apply și yarn twenty plan.

Opțiuni pentru modul de dezvoltare

Ce puteți construi

Aplicațiile sunt compuse din entități — fiecare definită într-un fișier TypeScript cu un singur export default: Referință completă: Concepte.

Pașii următori

Configurare

Identitatea aplicației, rolul implicit, hook-urile de instalare și dezinstalare, resursele publice.

Date

Obiecte, câmpuri și relații bidirecționale.

Logică

Funcții logice, abilități, agenți și conexiuni OAuth.

Aspect

Vizualizări, navigare, layouturi de pagină, componente front-end.

Operațiuni

CLI, testare, remote-uri, CI și publicarea aplicației.