Documentation Index
Fetch the complete documentation index at: https://docs.get-clara.tech/llms.txt
Use this file to discover all available pages before exploring further.
前提条件
Twentyをインストールして使用する前に、以下をコンピュータにインストールしてください。npmは使えません。代わりにyarnを使用してください。
npmは使えません。代わりにyarnを使用してください。 Yarnは今Node.jsに同梱されているので、別途インストールする必要はありません。
Yarnを有効にするには、まだしていない場合はcorepack enableを実行するだけです。
npmは使えません。代わりにyarnを使用してください。 Yarnは今Node.jsに同梱されているので、別途インストールする必要はありません。
Yarnを有効にするには、まだしていない場合はcorepack enableを実行するだけです。Yarnを有効にするには、まだしていない場合はcorepack enableを実行するだけです。
- WSLをインストール
管理者としてPowerShellを開き、次のコマンドを実行します。
コンピュータを再起動するプロンプトが表示されるはずです。 表示されなければ、手動で再起動してください。 表示されなければ、手動で再起動してください。 表示されなければ、手動で再起動してください。再起動後、PowerShellウィンドウが開き、Ubuntuをインストールします。 これには少し時間がかかるかもしれません。
再起動後、PowerShellウィンドウが開き、Ubuntuをインストールします。 これには少し時間がかかるかもしれません。
Ubuntuインストールのためにユーザー名とパスワードを設定するプロンプトが表示されます。 これには少し時間がかかるかもしれません。
再起動後、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は、すべての寄稿者が同じバージョンを使用することを保証します。
.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キーの設定をまだ行っていない場合は、こちらで学べます。```bash
git clone git@github.com:twentyhq/twenty.git
```bash
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 というスーパーユーザーロールが作成されます。Role name | Attributes | Member of
-----------+-------------+-----------
postgres | Superuser | {}
john | Superuser | {}
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
postgres、パスワードはpostgresです。
ステップ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オプション2： dockerをインストールしている場合： 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 は単一ワークスペースモードで動作し、ワークスペースは 1 つだけ作成できます。 マルチワークスペース対応を有効にするには（サブドメインベースの機能のテストに有用）、サーバーの .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)
バックエンド
トラブルシューティング
問題が発生した場合は、トラブルシューティングを確認して解決策を見つけてください。