Configurare locală

Cerințe

Linux și macOS
Windows (WSL)

Înainte de a instala și utiliza Twenty, asigurați-vă că instalați următoarele pe computerul dvs.:

npm nu va funcționa, ar trebui să folosiți yarn în schimb. Yarn este acum livrat cu Node.js, așa că nu este nevoie să-l instalați separat. Trebuie doar să rulați corepack enable pentru a activa Yarn dacă nu ați făcut acest lucru deja.

Instalați WSL Deschideți PowerShell ca Administrator și rulați:

wsl --install

Ar trebui să vedeți acum un mesaj pentru a reporni computerul. Dacă nu, reporniți-l manual.La repornire, o fereastră PowerShell se va deschide și va instala Ubuntu. Acest lucru poate dura ceva timp. Veți vedea un mesaj pentru a crea un nume de utilizator și o parolă pentru instalarea Ubuntu.

Instalați și configurați git

sudo apt-get install git

git config --global user.name "Numele Dvs."

git config --global user.email "emailul@domeniu.com"

Instalați nvm, node.js și yarn

Folosiți nvm pentru a instala versiunea corectă de node. Fișierul .nvmrc asigură că toți contribuitorii folosesc aceeași versiune.

sudo apt-get install curl

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash

Închideți și redeschideți terminalul pentru a utiliza nvm. Apoi rulați următoarele comenzi.

nvm install # instalează versiunea recomandată de node

nvm use # folosește versiunea recomandată de node

corepack enable

Pasul 1: Clonarea Git

Rulați în terminalul dvs. comanda următoare.

SSH (Recomandat)
HTTPS

Dacă nu ați configurat deja cheile SSH, puteți învăța cum să faceți acest lucru aici.

git clone git@github.com:twentyhq/twenty.git

git clone https://github.com/twentyhq/twenty.git

Pasul 2: Poziționați-vă la rădăcină

cd twenty

Trebuie să rulați toate comenzile în pașii următori de la rădăcina proiectului.

Pasul 3: Configurarea unei baze de date PostgreSQL

Linux
Mac OS
Windows (WSL)

Opțiunea 1 (preferată): Pentru a configura local baza de date: Folosiți următorul link pentru a instala PostgreSQL pe mașina dvs. Linux: Instalare PostgreSQL

  psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"

Notă: Ar putea fi nevoie să adăugați sudo -u postgres la comandă înainte de psql pentru a evita erorile de permisiune.Opțiunea 2: Dacă aveți docker instalat:

  make -C packages/twenty-docker postgres-on-docker

Opțiunea 1 (preferată): Pentru a configura local baza de date cu 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;"

Puteți verifica dacă serverul PostgreSQL este activ executând:

  brew services list

Instalatorul s-ar putea să nu creeze implicit utilizatorul postgres la instalarea prin Homebrew pe macOS. În schimb, creează un rol PostgreSQL care se potrivește cu numele de utilizator al macOS-ului dvs. (de ex., “john”). Pentru a verifica și crea utilizatorul postgres dacă este necesar, urmați acești pași:

  # Conectare la PostgreSQL
  psql postgres
  sau
  psql -U $(whoami) -d postgres

Odată ce ajungeți la promptul psql (postgres=#), rulați:

 # Listați rolurile PostgreSQL existente
 \du

Veți vedea un rezultat similar cu:

 Nume rol | Atribute  | Membru al
 -----------+-------------+-----------
 john      | Superutilizator   | {}

Dacă nu vedeți un rol postgres listat, mergeți la pasul următor. Creați rolul postgres manual:

 CREATE ROLE postgres WITH SUPERUSER LOGIN;

Acest lucru creează un rol de superutilizator numit postgres cu drept de autentificare.

Nume rol | Atribute  | Membru al
-----------+-------------+-----------
postgres  | Superutilizator   | {}
john      | Superutilizator   | {}

Opțiunea 2: Dacă aveți docker instalat:

  make -C packages/twenty-docker postgres-on-docker

Toți pașii următori trebuie rulați în terminalul WSL (în cadrul mașinii dvs. virtuale)Opțiunea 1: Pentru a configura local PostgreSQL: Folosiți următorul link pentru a instala PostgreSQL pe mașina dvs. virtuală Linux: Instalare PostgreSQL

  psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"

Notă: Ar putea fi nevoie să adăugați sudo -u postgres la comandă înainte de psql pentru a evita erorile de permisiune.Opțiunea 2: Dacă aveți docker instalat: Rularea Docker pe WSL adaugă un strat suplimentar de complexitate. Folosiți această opțiune doar dacă sunteți confortabil cu pașii suplimentari implicați, inclusiv activarea Docker Desktop WSL2.

  make -C packages/twenty-docker postgres-on-docker

Acum puteți accesa baza de date la localhost:5432. Dacă ați folosit opțiunea Docker de mai sus, datele implicite de autentificare sunt utilizatorul postgres și parola postgres. Pentru instalările native PostgreSQL, folosiți datele de autentificare și rolurile configurate pe mașina dvs.

Pasul 4: Configurați o bază de date Redis (cache)

Twenty necesită un cache Redis pentru a oferi cea mai bună performanță.

Linux
Mac OS
Windows (WSL)

Opțiunea 1: Pentru a configura local Redis: Folosiți următorul link pentru a instala Redis pe mașina dvs. Linux: Instalare RedisOpțiunea 2: Dacă aveți docker instalat:

  make -C packages/twenty-docker redis-on-docker

Opțiunea 1 (preferată): Pentru a configura local Redis cu brew:

brew install redis

Porniți serverul Redis:

brew services start redis

Opțiunea 2: Dacă aveți docker instalat:

  make -C packages/twenty-docker redis-on-docker

Opțiunea 1: Pentru a configura local Redis: Folosiți următorul link pentru a instala Redis pe mașina dvs. virtuală Linux: Instalare RedisOpțiunea 2: Dacă aveți docker instalat:

  make -C packages/twenty-docker redis-on-docker

Dacă aveți nevoie de o interfață grafică pentru client, vă recomandăm Redis Insight (versiune gratuită disponibilă).

Pasul 5: Configurați variabilele de mediu

Utilizați variabile de mediu sau fișiere .env pentru a configura proiectul dvs. Mai multe informații aici. Copiați fișierele .env.example din /front și /server:

cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env

Modul Multi-Workspace: În mod implicit, Twenty rulează în modul cu un singur spațiu de lucru, în care poate fi creat un singur spațiu de lucru. Pentru a activa suportul multi-spațiu de lucru (util pentru testarea funcționalităților bazate pe subdomenii), setați IS_MULTIWORKSPACE_ENABLED=true în fișierul .env al serverului. Consultați Modul Multi-Workspace pentru detalii.

Pasul 6: Instalarea dependențelor

Pentru a construi serverul Twenty și a adăuga date în baza dvs. de date, rulați următoarea comandă:

yarn

Rețineți că npm sau pnpm nu vor funcționa

Pasul 7: Rularea proiectului

Linux
Mac OS
Windows (WSL)

În funcție de distribuția Linux pe care o folosiți, serverul Redis s-ar putea să fie pornit automat. Dacă nu, verificați ghidul de instalare Redis pentru distribuția dvs.

Redis ar trebui să fie deja pornit. Dacă nu, rulați:

brew services start redis

Setați baza de date cu următoarea comandă:

npx nx database:reset twenty-server

Porniți serverul, worker-ul și serviciile frontend:

npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front

Alternativ, puteți porni toate serviciile odată:

npx nx start

Pasul 8: Utilizați Twenty

Front-end Frontend-ul Twenty va rula la http://localhost:3001. Vă puteți loga folosind contul demo implicit: tim@apple.dev (parolă: tim@apple.dev) Back-end

Serverul Twenty va fi operativ la http://localhost:3000
API-ul GraphQL poate fi accesat la http://localhost:3000/graphql
API-ul REST poate fi accesat la http://localhost:3000/rest

Depanare

Dacă întâmpinați vreo problemă, verificați Depanare pentru soluții.

Dezvoltatori

Extend

Self-Host

Contribute

Cerințe

Pasul 1: Clonarea Git

Pasul 2: Poziționați-vă la rădăcină

Pasul 3: Configurarea unei baze de date PostgreSQL

Pasul 4: Configurați o bază de date Redis (cache)

Pasul 5: Configurați variabilele de mediu

Pasul 6: Instalarea dependențelor

Pasul 7: Rularea proiectului

Pasul 8: Utilizați Twenty

Depanare

Dezvoltatori

Extend

Self-Host

Contribute

​Cerințe

​Pasul 1: Clonarea Git

​Pasul 2: Poziționați-vă la rădăcină

​Pasul 3: Configurarea unei baze de date PostgreSQL

​Pasul 4: Configurați o bază de date Redis (cache)

​Pasul 5: Configurați variabilele de mediu

​Pasul 6: Instalarea dependențelor

​Pasul 7: Rularea proiectului

​Pasul 8: Utilizați Twenty

​Depanare

Cerințe

Pasul 1: Clonarea Git

Pasul 2: Poziționați-vă la rădăcină

Pasul 3: Configurarea unei baze de date PostgreSQL

Pasul 4: Configurați o bază de date Redis (cache)

Pasul 5: Configurați variabilele de mediu

Pasul 6: Instalarea dependențelor

Pasul 7: Rularea proiectului

Pasul 8: Utilizați Twenty

Depanare