Místní nastavení

Předpoklady

Linux a MacOS
Windows (WSL)

Než nainstalujete a použijete Twenty, ujistěte se, že máte na svém počítači nainstalovány následující balíčky:

npm nebude fungovat, měli byste místo něj použít yarn. Yarn je nyní součástí Node.js, takže jej nemusíte instalovat samostatně. Musíte pouze spustit corepack enable, abyste povolili Yarn, pokud jste to ještě neudělali.

Nainstalujte WSL Otevřete PowerShell jako správce a spusťte:

wsl --install

Nyní byste měli vidět výzvu k restartování počítače. Pokud ne, restartujte jej ručně.Při restartu se otevře okno PowerShell a nainstaluje Ubuntu. Tento proces může chvíli trvat. Zobrazí se výzva k vytvoření uživatelského jména a hesla pro vaši instalaci Ubuntu.

Nainstalujte a nastavte git

sudo apt-get install git

git config --global user.name "Vaše Jméno"

git config --global user.email "[email protected]"

Nainstalujte nvm, node.js a yarn

Použijte nvm pro instalaci správné verze node. nvmrc zajišťuje, že všichni přispěvatelé používají stejnou verzi.

sudo apt-get install curl

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

Zavřete a znovu otevřete terminál, abyste použili nvm. Potom spusťte následující příkazy.

nvm install # instaluje doporučenou verzi node

nvm use # používá doporučenou verzi node

corepack enable

Krok 1: Git Clone

V terminálu spusťte následující příkaz.

SSH (Doporučeno)
HTTPS

Pokud jste ještě nenastavili SSH klíče, můžete se naučit, jak to udělat, zde.

git clone [email protected]:twentyhq/twenty.git

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

Krok 2: Umístěte se na kořen

cd twenty

Všechny příkazy v následujících krocích byste měli provádět z kořene projektu.

Krok 3: Nastavení PostgreSQL databáze

Linux
Mac OS
Windows (WSL)

Možnost 1 (doporučeno): Pro lokalní vytvoření databáze: Použijte následující odkaz pro instalaci PostgreSQL na vašem Linuxovém stroji: Instalace PostgreSQL

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

Poznámka: Možná budete potřebovat přidat sudo -u postgres k příkazu před psql, abyste předešli chybám s oprávněními.Možnost 2: Pokud máte nainstalován docker:

  make postgres-on-docker

Možnost 1 (doporučeno): Pro lokalní vytvoření databáze pomocí 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;"

Můžete zjistit, zda PostgreSQL server běží, spuštěním:

  brew services list

Instalátor nemusí automaticky vytvořit uživatele postgres při instalaci přes Homebrew na MacOS. Místo toho vytvoří PostgreSQL roli, která odpovídá vašemu uživatelskému jménu v MacOS (např. “john”). Pro zkontrolování a vytvoření uživatele postgres, pokud je to nutné, postupujte takto:

  # Připojit se k PostgreSQL
  psql postgres
  nebo
  psql -U $(whoami) -d postgres

Po zobrazení výzvy psql (postgres=#) spusťte:

 # Seznam existujících PostgreSQL rolí
 \du

Zobrazí se výstup podobný tomuto:

 Jméno role | Vlastnosti  | Členem
 -----------+-------------+-----------
 john      | Superuživatel | {}

Pokud nevidíte roli postgres, pokračujte na další krok. Vytvořte uživatelskou roli postgres ručně:

 CREATE ROLE postgres WITH SUPERUSER LOGIN;

Tím vytvoříte superuživatelskou roli pojmenovanou postgres s přístupovými právy.Možnost 2: Pokud máte nainstalován docker:

  make postgres-on-docker

Všechny následující kroky je třeba provádět v terminálu WSL (v rámci vaší virtuálního stroje).Možnost 1: Pro lokalní vytvoření PostgreSQL: Použijte následující odkaz pro instalaci PostgreSQL na vašem Linuxovém virtuálním stroji: Instalace PostgreSQL

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

Poznámka: Možná budete potřebovat přidat sudo -u postgres k příkazu před psql, abyste předešli chybám s oprávněními.Možnost 2: Pokud máte nainstalován docker: Používání Dockeru na WSL přidává další vrstvu složitosti. Použijte tuto možnost pouze pokud si jste jisti extra kroky včetně zapnutí Docker Desktop WSL2.

  make postgres-on-docker

Nyní můžete přistupovat k databázi na localhost:5432, s uživatelem postgres a heslem postgres.

Krok 4: Nastavení Redis databáze (cache)

Twenty vyžaduje ke svému provozu Redis cache pro zajištění nejlepšího výkonu.

Linux
Mac OS
Windows (WSL)

Možnost 1: Pro lokalní vytvoření Redis: Použijte následující odkaz pro instalaci Redis na vašem Linuxovém stroji: Instalace RedisMožnost 2: Pokud máte nainstalován docker:

  make redis-on-docker

Možnost 1 (doporučeno): Pro lokalní vytvoření Redis pomocí brew:

brew install redis

Spusťte redis server: brew services start redisMožnost 2: Pokud máte nainstalován docker:

  make redis-on-docker

Možnost 1: Pro lokalní vytvoření Redis: Použijte následující odkaz pro instalaci Redis na vašem Linuxovém virtuálním stroji: Instalace RedisMožnost 2: Pokud máte nainstalován docker:

  make redis-on-docker

Pokud potřebujete GUI klienta, doporučujeme redis insight (dostupná je bezplatná verze)

Krok 5: Nastavení proměnných prostředí

Použijte proměnné prostředí nebo .env soubory, abyste nakonfigurovali váš projekt. Více informací zde Zkopírujte soubory .env.example v /front a /server:

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

Multi-Workspace Mode: By default, Twenty runs in single-workspace mode where only one workspace can be created. To enable multi-workspace support (useful for testing subdomain-based features), set IS_MULTIWORKSPACE_ENABLED=true in your server .env file. See Multi-Workspace Mode for details.

Krok 6: Instalace závislostí

Pro sestavení Twenty serveru a zavedení některých dat do vaší databáze spusťte následující příkaz:

yarn

Všimněte si, že npm nebo pnpm nebudou fungovat.

Krok 7: Spuštění projektu

Linux
Mac OS
Windows (WSL)

V závislosti na vaší Linuxové distribuci mohl být Redis server spuštěn automaticky. Pokud ne, zkontrolujte instalační průvodce Redis pro vaši distribuci.

Redis by již měl být spuštěn. Pokud ne, spusťte:

brew services start redis

Nastavte svou databázi pomocí následujícího příkazu:

npx nx database:reset twenty-server

Spusťte server, pracovní proces a frontendové služby:

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

Alternativně můžete spustit všechny služby najednou:

npx nx start

Krok 8: Použijte Twenty

Frontend Frontend Twenty bude spuštěný na http://localhost:3001. Můžete se přihlásit pomocí výchozího demo účtu: [email protected] (heslo: [email protected]) Backend

Server Twenty poběží na http://localhost:3000
K GraphQL API se dostanete na http://localhost:3000/graphql
K REST API je přístup na http://localhost:3000/rest

Řešení potíží

Pokud narazíte na jakýkoli problém, zkontrolujte sekci Řešení potíží pro možná řešení.

Vývojáři

Extend

Self-Host

Contribute

Předpoklady

Krok 1: Git Clone

Krok 2: Umístěte se na kořen

Krok 3: Nastavení PostgreSQL databáze

Krok 4: Nastavení Redis databáze (cache)

Krok 5: Nastavení proměnných prostředí

Krok 6: Instalace závislostí

Krok 7: Spuštění projektu

Krok 8: Použijte Twenty

Řešení potíží

Vývojáři

Extend

Self-Host

Contribute

​Předpoklady

​Krok 1: Git Clone

​Krok 2: Umístěte se na kořen

​Krok 3: Nastavení PostgreSQL databáze

​Krok 4: Nastavení Redis databáze (cache)

​Krok 5: Nastavení proměnných prostředí

​Krok 6: Instalace závislostí

​Krok 7: Spuštění projektu

​Krok 8: Použijte Twenty

​Řešení potíží

Předpoklady

Krok 1: Git Clone

Krok 2: Umístěte se na kořen

Krok 3: Nastavení PostgreSQL databáze

Krok 4: Nastavení Redis databáze (cache)

Krok 5: Nastavení proměnných prostředí

Krok 6: Instalace závislostí

Krok 7: Spuštění projektu

Krok 8: Použijte Twenty

Řešení potíží