create-app

使用する場面

「Twenty アプリを作成して」や「新しいアプリのひな型を作成して」といったリクエストに使用します。

アプリを作成する

新しいアプリにはこのスキルを使用します。既存のアプリには develop-app または manage-app を使用します。

まず ../../references/concepts/how-apps-work.md と ../../references/concepts/operating-rules.md を読みます。

アプリの名前と目的を確認します。単体の CLI を使用します。

npm install -g twenty
twenty app init <app-name>
cd <app-name>
yarn install

app init はファイルを書き込むだけです。依存関係のインストール、Git の初期化、Docker の起動、認証、初回同期は行いません。

保存先を変更するには --path <directory> を、メタデータを指定するには --display-name または --description を使用します。位置引数の名前はパッケージ名です。

Twenty Cloud とセルフホスト型のインスタンスに対応しています。接続が必要な場合は、既存の Twenty ワークスペースの URL を尋ねます。ユーザーがローカルサーバーを希望する場合は、ドキュメントに記載されている Docker 環境またはリポジトリの開発環境を使用します。

twenty auth login --url <twenty-instance-url> --name dev
twenty app apply --create --remote dev

apply が成功した後に限り、アプリがインストールされたと伝えます。リクエストがひな型の作成だけであれば、ファイルと依存関係の作成後に終了します。依頼されていない限り、広範な検証は実行しないでください。統合テストには、../../references/develop-app/tests.md で説明されている分離されたテストインスタンスを使用します。

テンプレートには、メインページ、そのレイアウトとナビゲーション項目、ヘルスチェック関数が含まれています。アプリに UI が不要な場合は、プレースホルダーのページとそのレイアウトおよびナビゲーションを削除します。2 つ目のヘルスチェックを宣言するのではなく、既存のヘルスチェックを拡張します。

作成後、エンティティと UI には develop-app、twenty app apply による範囲を限定した同期には manage-app、リリース作業には publish-app を使用します。