ローカルセットアップ

寄稿者（または好奇心旺盛な開発者）のためのガイドで、ローカルにTwentyを実行したい人向けです。

​

前提条件

LinuxとmacOS

Twentyをインストールして使用する前に、以下をコンピュータにインストールしてください。

• Git
• Node v24.5.0
• yarn v4
• nvm

npmは使えません。代わりにyarnを使用してください。 npmは使えません。代わりにyarnを使用してください。 Yarnは今Node.jsに同梱されているので、別途インストールする必要はありません。 Yarnを有効にするには、まだしていない場合はcorepack enableを実行するだけです。 npmは使えません。代わりにyarnを使用してください。 Yarnは今Node.jsに同梱されているので、別途インストールする必要はありません。 Yarnを有効にするには、まだしていない場合はcorepack enableを実行するだけです。Yarnを有効にするには、まだしていない場合はcorepack enableを実行するだけです。

Windows（WSL）

1. WSLをインストール 管理者としてPowerShellを開き、次のコマンドを実行します。

wsl --install

コンピュータを再起動するプロンプトが表示されるはずです。 表示されなければ、手動で再起動してください。 表示されなければ、手動で再起動してください。 表示されなければ、手動で再起動してください。

再起動後、PowerShellウィンドウが開き、Ubuntuをインストールします。 これには少し時間がかかるかもしれません。 再起動後、PowerShellウィンドウが開き、Ubuntuをインストールします。 これには少し時間がかかるかもしれません。 Ubuntuインストールのためにユーザー名とパスワードを設定するプロンプトが表示されます。

2. gitをインストールして設定する

sudo apt-get install git

git config --global user.name "Your Name"

git config --global user.email "[e-mail]"

3. nvm、node.js、yarnをインストールする

nvmを使用して正しいnodeバージョンをインストールします。 .nvmrcは、すべての寄稿者が同じバージョンを使用することを保証します。 .nvmrcは、すべての寄稿者が同じバージョンを使用することを保証します。

sudo apt-get install curl

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash

nvmを使用できるようにするには、ターミナルを閉じて再度開いてください。 次のコマンドを実行します。 次のコマンドを実行します。 次のコマンドを実行します。

nvm install # installs recommended node version

nvm use # use recommended node version

corepack enable

---

​

ステップ1：Gitクローン

ターミナルで次のコマンドを実行します。

SSH（推奨）

SSHキーの設定をまだ行っていない場合は、こちらで学べます。```bash git clone [e-mail]:twentyhq/twenty.git

```bash
git clone [e-mail]:twentyhq/twenty.git

HTTPS

git clone https://github.com/twentyhq/twenty.git

​

ステップ 2: ルートディレクトリに移動する

cd twenty

プロジェクトのルートで次のステップのすべてのコマンドを実行する必要があります。

​

ステップ3：PostgreSQLデータベースをセットアップします

Linux

オプション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

Mac OS

オプション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;"

PostgreSQLサーバーが稼働しているかどうかを確認するには、以下を実行してください。

  brew services list

macOSでHomebrew経由でインストールする場合、 インストーラーがデフォルトでpostgresユーザーを作成しないことがあります。 代わりに、macOSのユーザー名（例：「john」）と一致するPostgreSQLロールを作成します。 必要に応じて、postgresユーザーを確認して作成するには、次の手順を実行してください。

  # Connect to PostgreSQL
  psql postgres
  or
  psql -U $(whoami) -d postgres

psqlプロンプト（postgres=#）で次を実行します。

 # List existing PostgreSQL roles
 \du

以下のような出力が表示されます。

 Role name | Attributes  | Member of
 -----------+-------------+-----------
 john      | Superuser   | {}

postgresロールがリストに表示されない場合は、次のステップに進んでください。 postgresロールを手動で作成します。

 CREATE ROLE postgres WITH SUPERUSER LOGIN;

これにより、ログイン権限を持つ postgres というスーパーユーザーロールが作成されます。

Role name | Attributes  | Member of
-----------+-------------+-----------
postgres  | Superuser   | {}
john      | Superuser   | {}

オプション2： dockerをインストールしている場合：

  make -C packages/twenty-docker postgres-on-docker

Windows（WSL）

以下のすべてのステップは、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

オプション1： Redisをローカルでプロビジョニングするには： LinuxマシンにRedisをインストールするには、次のリンクを使用してください：Redisインストール

オプション2： dockerをインストールしている場合：

  make -C packages/twenty-docker redis-on-docker

Mac OS

オプション1（推奨）： brewでredisをローカルプロビジョニングするには：

brew install redis

Redis サーバーを起動する：

brew services start redis

オプション2： dockerをインストールしている場合：

  make -C packages/twenty-docker redis-on-docker

Windows（WSL）

オプション1： Redisをローカルでプロビジョニングするには： Linux仮想マシンにRedisをインストールするには、次のリンクを使用してください：Redisインストール

オプション2： dockerをインストールしている場合：

  make -C packages/twenty-docker redis-on-docker

クライアント GUI が必要な場合は、Redis Insight（無料版あり）をお勧めします。

​

ステップ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 は単一ワークスペースモードで動作し、ワークスペースは 1 つだけ作成できます。 マルチワークスペース対応を有効にするには（サブドメインベースの機能のテストに有用）、サーバーの .env ファイルで IS_MULTIWORKSPACE_ENABLED=true を設定してください。 詳細はマルチワークスペースモードを参照してください。

​

ステップ6：依存関係をインストールします

Twentyサーバーを構築し、データベースにデータをシードするには、以下のコマンドを実行します：

yarn

npmまたはpnpmは使えません

​

ステップ7：プロジェクトを実行する

Linux

Linuxディストリビューションによっては、Redisサーバーが自動的に開始されるかもしれません。 そうでない場合は、Redisインストールガイドを参照し、お使いのディストリビューションに合わせて確認してください。

Mac OS

Redisはすでに稼働しているはずです。 稼働していなかった場合は、以下を実行してください：

brew services start redis

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を使用する

フロントエンド

Twentyのフロントエンドはhttp://localhost:3001で稼働しています。 デフォルトのデモアカウントを使用してログインできます: [e-mail] (パスワード: [e-mail])

バックエンド

• Twentyのサーバーはhttp://localhost:3000で稼働しています
• GraphQL API は http://localhost:3000/graphql でアクセスできます
• REST API は http://localhost:3000/rest でアクセスできます

​

トラブルシューティング

問題が発生した場合は、トラブルシューティングを確認して解決策を見つけてください。