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.
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:
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 PowerShellu 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 "vasemail@domena.com"
- 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
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.
Pokud jste ještě nenastavili SSH klíče, můžete se naučit, jak to udělat, zde.git clone git@github.com:twentyhq/twenty.git
git clone https://github.com/twentyhq/twenty.git
Krok 2: Umístěte se na kořen
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 lokální 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;"
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 -C packages/twenty-docker 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;"
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
# Seznam existujících PostgreSQL rolí
\du
Jméno role | Vlastnosti | Členem
-----------+-------------+-----------
john | Superuživatel | {}
postgres, pokračujte na další krok.
Vytvořte uživatelskou roli postgres ručně: CREATE ROLE postgres WITH SUPERUSER LOGIN;
postgres s přístupovými právy.Jméno role | Vlastnosti | Členem
-----------+-------------+-----------
postgres | Superuživatel | {}
john | Superuživatel | {}
make -C packages/twenty-docker 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 lokální zprovoznění 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;"
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 -C packages/twenty-docker postgres-on-docker
localhost:5432.
Pokud jste použili výše uvedenou možnost Dockeru, výchozí přihlašovací údaje jsou uživatelské jméno postgres a heslo postgres. U nativních instalací PostgreSQL použijte přihlašovací údaje a role nakonfigurované na vašem počítači.
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 -C packages/twenty-docker redis-on-docker
Možnost 1 (doporučeno): Pro lokalní vytvoření Redis pomocí brew:Spusťte svůj server Redis:brew services start redis
make -C packages/twenty-docker 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 -C packages/twenty-docker redis-on-docker
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
Režim více pracovních prostorů: Ve výchozím nastavení běží Twenty v režimu jednoho pracovního prostoru, ve kterém lze vytvořit pouze jeden pracovní prostor. Chcete-li povolit podporu více pracovních prostorů (užitečné pro testování funkcí založených na subdoménách), nastavte v serverovém souboru .env hodnotu IS_MULTIWORKSPACE_ENABLED=true. Podrobnosti viz Režim více pracovních prostorů. 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:
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
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. npx nx database:reset twenty-server
npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front
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: tim@apple.dev (heslo: tim@apple.dev)
Backend
Řešení potíží
Pokud narazíte na jakýkoli problém, zkontrolujte sekci Řešení potíží pro možná řešení.