Documentation Index
Fetch the complete documentation index at: https://docs.twenty.com/llms.txt
Use this file to discover all available pages before exploring further.
Требования
Linux и macOS
Windows (WSL)
Прежде чем установить и использовать Twenty, убедитесь, что у вас установлено следующее:npm не будет работать, используйте yarn. Yarn теперь поставляется в комплекте с Node.js, так что устанавливать его отдельно не нужно.
Нужно лишь выполнить corepack enable, чтобы активировать Yarn, если вы еще этого не сделали.
- Установите WSL
Откройте PowerShell от имени администратора и выполните:
Теперь должно появиться приглашение на перезагрузку компьютера. Если нет, перезагрузите его вручную.После перезагрузки откроется окно PowerShell и начнётся установка Ubuntu. Это может занять некоторое время.
Появится запрос на создание имени пользователя и пароля для вашей установки Ubuntu.
- Установите и настройте git
sudo apt-get install git
git config --global user.name "Your Name"
git config --global user.email "youremail@domain.com"
- Установите nvm, node.js и yarn
Используйте nvm, чтобы установить правильную версию node. .nvmrc гарантирует, что все участники используют одну и ту же версию.
sudo apt-get install curl
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
nvm install # устанавливает рекомендуемую версию node
nvm use # использовать рекомендуемую версию node
corepack enable
Шаг 1: Клонирование с помощью Git
Выполните следующую команду в терминале.
SSH (Рекомендовано)
HTTPS
Если вы еще не настроили SSH ключи, вы можете узнать, как это сделать здесь.git clone git@github.com:twentyhq/twenty.git
git clone https://github.com/twentyhq/twenty.git
Шаг 2: Перейдите в корень
Все команды в следующих шагах следует выполнять из корня проекта.
Шаг 3: Настройка базы данных PostgreSQL
Linux
Mac OS
Windows (WSL)
Опция 1 (предпочтительно): Чтобы настроить базу данных локально:
Используйте следующую ссылку для установки PostgreSQL на компьютер с Linux: Установка PostgreSQLpsql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
sudo -u postgres к команде перед psql, чтобы избежать ошибок с правами.Опция 2: Если у вас установлен docker: make -C packages/twenty-docker postgres-on-docker
Опция 1 (предпочтительно): Чтобы настроить вашу базу данных локально с помощью 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 по умолчанию при установке
через Homebrew на macOS. Вместо этого он создает роль PostgreSQL, которая совпадает с вашим именем пользователя в MacOS
например, “john”.
Чтобы проверить и создать пользователя postgres, при необходимости выполните следующие шаги:# Подключитесь к PostgreSQL
psql postgres
или
psql -U $(whoami) -d postgres
# Список существующих ролей PostgreSQL
\du
Role name | Attributes | Member of
-----------+-------------+-----------
john | Superuser | {}
postgres в списке, перейдите к следующему шагу.
Создайте роль postgres вручную:CREATE ROLE postgres WITH SUPERUSER LOGIN;
postgres с доступом для входа.Имя роли | Атрибуты | Членство в
-----------+-------------+-----------
postgres | Суперпользователь | {}
john | Суперпользователь | {}
make -C packages/twenty-docker postgres-on-docker
Все последующие шаги следует выполнять в терминале WSL (внутри вашей виртуальной машины)Опция 1: Чтобы настроить PostgreSQL локально:
Используйте следующую ссылку для установки PostgreSQL на виртуальную машину с Linux: Установка PostgreSQLpsql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
sudo -u postgres к команде перед psql, чтобы избежать ошибок с правами.Опция 2: Если у вас установлен docker:
Запуск Docker на WSL добавляет дополнительный уровень сложности.
Используйте эту опцию только если вы комфортно себя чувствуете с дополнительными шагами, включая включение Docker Desktop WSL2. make -C packages/twenty-docker postgres-on-docker
localhost:5432.
Если вы использовали вариант с Docker выше, учетные данные по умолчанию: пользователь postgres и пароль postgres. Для нативных установок PostgreSQL используйте учетные данные и роли, настроенные на вашей машине.
Шаг 4: Настройка базы данных Redis (кэш)
Twenty требует кэша Redis для обеспечения наилучшей производительности.
Linux
Mac OS
Windows (WSL)
Опция 1: Чтобы настроить Redis локально:
Используйте следующую ссылку для установки Redis на вашу Linux машину: Установка RedisОпция 2: Если у вас установлен docker: make -C packages/twenty-docker redis-on-docker
Опция 1 (предпочтительно): Чтобы настроить Redis локально с помощью brew:Запустите сервер Redis:brew services start redis
make -C packages/twenty-docker redis-on-docker
Опция 1: Чтобы настроить Redis локально:
Используйте следующую ссылку для установки Redis на вашу Linux виртуальную машину: Установка RedisОпция 2: Если у вас установлен docker: make -C packages/twenty-docker redis-on-docker
Шаг 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
Режим нескольких рабочих пространств: По умолчанию Twenty работает в режиме одного рабочего пространства, где можно создать только одно рабочее пространство. Чтобы включить поддержку нескольких рабочих пространств (полезно для тестирования функций, основанных на поддоменах), установите IS_MULTIWORKSPACE_ENABLED=true в файле .env вашего сервера. См. Режим нескольких рабочих пространств для подробностей. Шаг 6: Установка зависимостей
Чтобы собрать сервер Twenty и добавить данные в вашу базу данных, выполните следующую команду:
Обратите внимание, что npm или pnpm не будут работать
Шаг 7: Запуск проекта
Linux
Mac OS
Windows (WSL)
В зависимости от вашего дистрибутива Linux, сервер Redis может быть запущен автоматически.
Если нет, проверьте Руководство по установке Redis для вашего дистрибутива. Redis должен уже работать. Если нет, выполните:brew services start redis
В зависимости от вашей дистрибуции Linux, сервер Redis может быть запущен автоматически.
Если нет, проверьте руководство по установке Redis для вашего дистрибутива. npx nx database:reset twenty-server
npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front
Шаг 8: Использовать Twenty
Frontend
Фронтенд Twenty будет работать на http://localhost:3001.
Вы можете войти, используя учетную запись демо по умолчанию: tim@apple.dev (пароль: tim@apple.dev)
Backend
Устранение неполадок
Если у вас возникли проблемы, проверьте Устранение неполадок для получения решений.