Přejít na hlavní obsah
Header

Předpoklady

  • Linux and 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.

Krok 1: Git Clone

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

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)
Option 1 (preferred): To provision your database locally: Use the following link to install Postgresql on your Linux machine: Postgresql Installation
  psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
Note: You might need to add sudo -u postgres to the command before psql to avoid permission errors.
**Option 2:** If you have docker installed:
```bash
  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)
Option 1: To provision your Redis locally: Use the following link to install Redis on your Linux machine: Redis Installation
**Option 2:** If you have docker installed:
```bash
  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

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.
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: 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í.