Перейти к основному содержанию
Header

Требования

  • Linux and MacOS
  • Windows (WSL)
Прежде чем установить и использовать Twenty, убедитесь, что у вас установлено следующее:
npm не будет работать, используйте yarn. Yarn теперь поставляется в комплекте с Node.js, так что устанавливать его отдельно не нужно. Нужно лишь выполнить corepack enable, чтобы активировать Yarn, если вы еще этого не сделали.

Шаг 1: Клонирование с помощью Git

Выполните следующую команду в терминале.

Шаг 2: Перейдите в корень

cd twenty
Все команды в следующих шагах следует выполнять из корня проекта.

Шаг 3: Настройка базы данных PostgreSQL

  • 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
```
Теперь вы можете получить доступ к базе данных по адресу localhost:5432, с пользователем postgres и паролем postgres.

Шаг 4: Настройка базы данных Redis (кэш)

Twenty требует кэша Redis для обеспечения наилучшей производительности
  • 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
```
Если вам нужен графический интерфейс клиента, мы рекомендуем redis insight (доступна бесплатная версия)

Шаг 5: Настройка переменных окружения

Используйте переменные окружения или файлы .env для настройки вашего проекта. Подробнее здесь. Скопируйте .env.example файлы в /front и /server:
cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env

Шаг 6: Установка зависимостей

Чтобы собрать сервер Twenty и добавить данные в вашу базу данных, выполните следующую команду:
yarn
Обратите внимание, что npm или pnpm не будут работать

Шаг 7: Запуск проекта

  • Linux
  • Mac OS
  • Windows (WSL)
В зависимости от вашей дистрибуции Linux, сервер Redis может быть запущен автоматически. Если нет, проверьте руководство по установке Redis для вашего дистрибутива.
Настройте вашу базу данных с помощью следующей команды:
npx nx database:reset twenty-server
Запустите сервер, рабочую программу и сервисы фронтенда:
npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front
В качестве альтернативы, вы можете запустить все сервисы сразу:
npx nx start

Шаг 8: Использовать Twenty

Frontend Фронтенд Twenty будет работать на http://localhost:3001. Вы можете войти, используя учетную запись демо по умолчанию: tim@apple.dev (пароль: tim@apple.dev) Backend

Устранение неполадок

Если у вас возникли проблемы, проверьте Устранение неполадок для получения решений.