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 # installs recommended node version
nvm use # use recommended node version
corepack enable
步骤 1：Git 克隆
在您的终端中，运行以下命令。
如果您尚未设置 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（首选）：**要在本地预配您的数据库：
使用以下链接在 Linux 机器上安装 PostgreSQL：PostgreSQL 安装 psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
psql 前添加 sudo -u postgres 以避免权限错误。**选项 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 用户。 相反，它会创建一个与您的 macOS 用户名（例如，“john”）匹配的 PostgreSQL 角色。
按照以下步骤检查并在必要时创建 postgres 用户： # Connect to PostgreSQL
psql postgres
or
psql -U $(whoami) -d postgres
# List existing PostgreSQL roles
\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：
使用以下链接在 Linux 虚拟机上安装 PostgreSQL：PostgreSQL 安装 psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
psql 前添加 sudo -u postgres 以避免权限错误。**选项 2：**如果您已安装 docker：
在 WSL 上运行 Docker 增加了额外的复杂性。
仅在您对涉及的额外步骤感到舒适时使用此选项，包括开启 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：
使用以下链接在 Linux 机器上安装 Redis：Redis 安装**选项 2：**如果您已安装 docker： make -C packages/twenty-docker redis-on-docker
**选项 1（推荐）：**通过 brew 在本地设置 Redis：启动您的 Redis 服务器：brew services start redis
make -C packages/twenty-docker redis-on-docker
**选项 1：**在本地供应您的 Redis：
使用以下链接在 Linux 虚拟机上安装 Redis：Redis 安装**选项 2：**如果您已安装 docker： make -C packages/twenty-docker redis-on-docker
步骤 5：设置环境变量
使用环境变量或 .env 文件配置您的项目。 更多信息请参见 此处.
复制 /front 和 /server 目录中的 .env.example 文件：
cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env
多工作区模式： 默认情况下，Twenty 以单工作区模式运行，在此模式下只能创建一个工作区。 要启用多工作区支持（对于测试基于子域的功能很有用），请在服务器的 .env 文件中设置 IS_MULTIWORKSPACE_ENABLED=true。 详见 多工作区模式。 步骤 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
前端
Twenty 的前端将在 http://localhost:3001 运行。
您可以使用默认的演示帐号登录：tim@apple.dev （密码：tim@apple.dev）
后端
故障排除
如果您遇到任何问题，请检查故障排除以获取解决方案。