Documentation Index
Fetch the complete documentation index at: https://docs.get-clara.tech/llms.txt
Use this file to discover all available pages before exploring further.
Prerequisiti
Linux e macOS
Windows (WSL)
Prima di poter installare e usare Twenty, assicurati di installare quanto segue sul tuo computer:npm non funzionerà, dovresti usare yarn invece. Yarn è ora incluso con Node.js, quindi non è necessario installarlo separatamente.
Devi solo eseguire corepack enable per abilitare Yarn se non l’hai ancora fatto.
- Installa WSL
Apri PowerShell come amministratore ed esegui:
Dovresti ora vedere un prompt per riavviare il computer. In caso contrario, riavvialo manualmente.Al riavvio, si aprirà una finestra di PowerShell e installerà Ubuntu. Questo potrebbe richiedere un po’ di tempo.
Vedrai un prompt per creare un nome utente e una password per la tua installazione di Ubuntu.
- Installa e configura Git
sudo apt-get install git
git config --global user.name "Your Name"
git config --global user.email "youremail@domain.com"
- Installa nvm, node.js e yarn
Usa nvm per installare la versione corretta di node. Il file .nvmrc garantisce che tutti i collaboratori utilizzino la stessa versione.
sudo apt-get install curl
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
Chiudi e riapri il tuo terminale per usare nvm. Poi esegui i seguenti comandi.
nvm install # installa la versione di node raccomandata
nvm use # usa la versione di node raccomandata
corepack enable
Passaggio 1: Clona con Git
Nel tuo terminale, esegui il seguente comando.
Se non hai già configurato le chiavi SSH, puoi imparare come farlo qui.git clone git@github.com:twentyhq/twenty.git
git clone https://github.com/twentyhq/twenty.git
Passaggio 2: Posizionati alla radice
Dovresti eseguire tutti i comandi nei passaggi successivi dalla radice del progetto.
Passaggio 3: Configura un database PostgreSQL
Linux
Mac OS
Windows (WSL)
Opzione 1 (preferita): Per predisporre il database in locale:
Usa il seguente link per installare PostgreSQL sulla tua macchina Linux: Installazione di PostgreSQL psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
Nota: Potrebbe essere necessario aggiungere sudo -u postgres al comando prima di psql per evitare errori di permessi.Opzione 2: Se hai Docker installato: make -C packages/twenty-docker postgres-on-docker
Opzione 1 (preferita): Per predisporre il database in locale con brew: brew install postgresql@16
export PATH="/opt/homebrew/opt/postgresql@16/bin:$PATH"
brew services start postgresql@16
psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
Puoi verificare se il server PostgreSQL è in esecuzione eseguendo:Il programma di installazione potrebbe non creare l’utente postgres per impostazione predefinita quando si installa
tramite Homebrew su macOS. Invece, crea un ruolo di PostgreSQL che corrisponde al tuo nome utente macOS
(es., “john”).
Per controllare e creare l’utente postgres se necessario, segui questi passaggi: # Connetti a PostgreSQL
psql postgres
o
psql -U $(whoami) -d postgres
Una volta nel prompt di psql (postgres=#), esegui: # Elenca i ruoli di PostgreSQL esistenti
\du
Vedrai un output simile a: Nome ruolo | Attributi | Membro di
-----------+-------------+-----------
john | Superuser | {}
Se non vedi un ruolo postgres elencato, procedi al passo successivo.
Crea manualmente il ruolo postgres: CREATE ROLE postgres WITH SUPERUSER LOGIN;
Questo crea un ruolo superuser chiamato postgres con accesso di login.Nome ruolo | Attributi | Membro di
-----------+-------------+-----------
postgres | Superuser | {}
john | Superuser | {}
Opzione 2: Se hai Docker installato: make -C packages/twenty-docker postgres-on-docker
Tutti i passaggi seguenti devono essere eseguiti nel terminale WSL (all’interno della tua macchina virtuale)Opzione 1: Per predisporre PostgreSQL in locale:
Usa il seguente link per installare PostgreSQL sulla tua macchina virtuale Linux: Installazione di PostgreSQL psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
Nota: Potrebbe essere necessario aggiungere sudo -u postgres al comando prima di psql per evitare errori di permessi.Opzione 2: Se hai Docker installato:
Eseguire Docker su WSL aggiunge un livello extra di complessità.
Usa questa opzione solo se ti senti a tuo agio con i passaggi extra coinvolti, incluso l’attivazione di Docker Desktop WSL2. make -C packages/twenty-docker postgres-on-docker
Ora puoi accedere al database all’indirizzo localhost:5432.
Se hai utilizzato l’opzione Docker sopra, le credenziali predefinite sono utente postgres e password postgres. Per le installazioni native di PostgreSQL, usa le credenziali e i ruoli configurati sulla tua macchina.
Passaggio 4: Configura un database Redis (cache)
Twenty richiede una cache Redis per offrire le migliori prestazioni.
Linux
Mac OS
Windows (WSL)
Opzione 1: Per predisporre Redis in locale:
Usa il seguente link per installare Redis sulla tua macchina Linux: Installazione di RedisOpzione 2: Se hai Docker installato: make -C packages/twenty-docker redis-on-docker
Opzione 1 (preferita): Per predisporre Redis in locale con brew:Avvia il tuo server Redis:brew services start redis
Opzione 2: Se hai Docker installato: make -C packages/twenty-docker redis-on-docker
Opzione 1: Per predisporre Redis in locale:
Usa il seguente link per installare Redis sulla tua macchina virtuale Linux: Installazione di RedisOpzione 2: Se hai Docker installato: make -C packages/twenty-docker redis-on-docker
Se hai bisogno di una GUI client, ti consigliamo Redis Insight (versione gratuita disponibile).
Passaggio 5: Configura le variabili d’ambiente
Usa variabili d’ambiente o file .env per configurare il tuo progetto. Maggiori informazioni qui.
Copia i file .env.example in /front e /server:
cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env
Modalità multi-workspace: Per impostazione predefinita, Twenty viene eseguito in modalità a singolo workspace in cui può essere creato un solo workspace. Per abilitare il supporto multi-workspace (utile per testare le funzionalità basate sui sottodomini), imposta IS_MULTIWORKSPACE_ENABLED=true nel file .env del server. Vedi Modalità multi-workspace per i dettagli.
Passaggio 6: Installazione delle dipendenze
Per costruire il server Twenty e popolare alcuni dati nel tuo database, esegui il seguente comando:
Nota che npm o pnpm non funzioneranno
Passaggio 7: Esecuzione del progetto
Linux
Mac OS
Windows (WSL)
A seconda della tua distribuzione Linux, il server Redis potrebbe essere avviato automaticamente.
In caso contrario, controlla la guida all’installazione di Redis per la tua distribuzione. Redis dovrebbe essere già in esecuzione. In caso contrario, esegui:brew services start redis
A seconda della tua distribuzione Linux, il server Redis potrebbe essere avviato automaticamente.
In caso contrario, controlla la guida all’installazione di Redis per la tua distribuzione.
Configura il tuo database con il seguente comando:
npx nx database:reset twenty-server
Avvia il server, il worker e i servizi del frontend:
npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front
In alternativa, puoi avviare tutti i servizi contemporaneamente:
Passo 8: Utilizza Twenty
Frontend
Il frontend di Twenty sarà in esecuzione su http://localhost:3001.
Puoi accedere utilizzando l’account demo predefinito: tim@apple.dev (password: tim@apple.dev)
Backend
Risoluzione dei problemi
Se riscontri problemi, controlla Risoluzione dei problemi per le soluzioni.