Skip to content

The open alternative to Salesforce, designed for AI.

10.8 KB
Raw Blame
---
title: Struttura del progetto
description: Cosa contiene un'app Twenty creata con lo scaffold — file, cartelle e cosa fa ognuno di essi.
---

import { PageBanner } from "/snippets/page-banner.mdx"

## Panoramica

Una nuova app generata da `twenty app init` si presenta così:

```text filename="my-twenty-app/"
my-twenty-app/
  package.json
  yarn.lock                                 # Created by app init; used by yarn install
  src/
    application-config.ts                   # Required — your app's entry point
    default-role.ts                         # Permissions for logic functions
    constants/
      universal-identifiers.ts              # Auto-generated UUIDs and metadata
    front-components/
      main-page.tsx                         # Welcome page component
    logic-functions/
      health-check.ts                       # Reports whether the app can run
    navigation-menu-items/
      main-page.navigation-menu-item.ts     # Sidebar entry for the welcome page
    page-layouts/
      main-page.page-layout.ts              # Standalone page hosting the component
    __tests__/
      application-config.test.ts            # Unit test
      global-setup.ts                       # Integration test setup (sync + uninstall)
      run-twenty.ts                         # CLI subprocess helper for tests
      schema.integration-test.ts            # Integration test against a live server
  .github/workflows/
    ci.yml                                  # Lint, typecheck, unit + integration tests
    cd.yml                                  # Deploy + install on push to main
    publish.yml                             # Publish to npm on version tags (with provenance)
  public/
    logo.svg                                # Static assets
  locales/
    en.json                                 # Source catalog; add <locale>.json files next to it
  vitest.config.ts                          # Integration test runner config
  vitest.unit.config.ts                     # Unit test runner config
  tsconfig.json, tsconfig.spec.json
  .nvmrc, .yarnrc.yml, .oxlintrc.json
  README.md, AGENTS.md, CLAUDE.md, CHANGELOG.md, SETUP.md
```

## File principali

| File / Cartella                                                            | Scopo                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `src/application-config.ts`                                                | **Obbligatorio.** Il file di configurazione principale della tua app.                                                                                                                                                                                                                                                                                                                                                                                                     |
| `src/default-role.ts`                                                      | Ruolo predefinito che controlla a cosa possono accedere le tue funzioni logiche.                                                                                                                                                                                                                                                                                                                                                                                          |
| `src/constants/universal-identifiers.ts`                                   | UUID generati automaticamente e metadati (nome visualizzato, descrizione).                                                                                                                                                                                                                                                                                                                                                                                                |
| `src/front-components/`, `src/navigation-menu-items/`, `src/page-layouts/` | Una pagina di benvenuto iniziale: un front component renderizzato da un page layout autonomo, raggiungibile dalla sidebar.                                                                                                                                                                                                                                                                                                                                                |
| `src/logic-functions/health-check.ts`                                      | Un [controllo di integrità](/it/developers/extend/apps/logic/logic-functions#health-check) iniziale che restituisce `ok`. Compilala per far emergere problemi di configurazione che solo la tua app può rilevare.                                                                                                                                                                                                                                                            |
| `src/__tests__/`                                                           | Un test unitario più un test di integrazione (con il relativo setup globale) che sincronizza l'app con un server reale.                                                                                                                                                                                                                                                                                                                                                   |
| `public/`                                                                  | Asset statici (immagini, font) serviti insieme alla tua app.                                                                                                                                                                                                                                                                                                                                                                                                              |
| `locales/`                                                                 | Cataloghi di traduzione. `en.json` è il catalogo di origine che `twenty app translations extract` compila; l'insieme di file qui è ciò che una sincronizzazione pubblica, quindi una cartella vuota dichiara che non ci sono traduzioni. `locales/compiled/` viene scritto da `twenty app pull` per le voci le cui stringhe di origine non sono ancora nell'albero, viene pubblicato anch'esso da una sincronizzazione e non è pensato per essere modificato manualmente. |
| `AGENTS.md` / `CLAUDE.md`                                                  | Linee guida per gli agenti di codice AI che lavorano sull'app.                                                                                                                                                                                                                                                                                                                                                                                                            |
| `CHANGELOG.md` / `SETUP.md`                                                | Changelog delle modifiche importanti e istruzioni di configurazione per lo sviluppo locale.                                                                                                                                                                                                                                                                                                                                                                               |

<Note>
  **L'organizzazione dei file dipende da te.** Le cartelle sopra sono convenzioni — la CLI rileva le entità tramite analisi AST sulle chiamate a `export default defineEntity(...)` indipendentemente da dove si trova il file.
</Note>

## Dipendenze

`twenty app init` inserisce `twenty-sdk`, `twenty-client-sdk` e `twenty-ui` in `devDependencies`, bloccati alla versione dell'SDK selezionata da quella versione della CLI. Mantieni le versioni generate per una nuova app e mantieni tutti e tre i pacchetti sincronizzati durante l'aggiornamento. La CLI può ricevere versioni patch in modo indipendente, quindi la sua versione non deve necessariamente corrispondere a quella di questi pacchetti.

Il valore `engines.twenty` generato imposta la versione minima del server alla versione major e minor di quell'SDK. I flussi di lavoro GitHub Actions generati bloccano separatamente la CLI.

* **`twenty-sdk`** fornisce definizioni delle app, helper di runtime e integrazione del renderer. Usa il pacchetto **`twenty`** installato separatamente per i comandi CLI e gli strumenti di build/scaffolding.
* **`twenty-client-sdk`** *viene* importato dal codice della tua app (`CoreApiClient`, `MetadataApiClient`, `RestApiClient`), ma Twenty lo fornisce a runtime: le funzioni di logica lo ricevono da un layer SDK generato e i componenti di front-end lo risolvono da moduli forniti dal server. La copia installata viene utilizzata solo per il type checking e per la build al momento del deploy, quindi non è mai necessario includerla nel bundle distribuito.

Mantenere uno qualsiasi dei pacchetti sotto `dependencies` lo inserisce nel bundle di runtime dell'app installata, dove rappresenta solo zavorra. `twenty app build` emette un avviso quando uno dei due è ancora elencato sotto `dependencies`.

Aggiungi come di consueto le dipendenze di runtime proprie della tua app (librerie che le tue funzioni di logica importano effettivamente a runtime) sotto `dependencies`. Mantieni l'albero snello: le `dependencies` vengono installate in un livello di runtime con un limite di 250 MB non compressi e una sincronizzazione o un'installazione non va a buon fine con un errore di dimensione delle dipendenze oltre tale soglia — le librerie UI e gli strumenti di sviluppo appartengono a `devDependencies`.

<PageBanner illustration="card-page-frontend-architecture" />