🔧

【Shopify.dev和訳】Apps/Dev Tools/Shopify ClI/Rails commands

2021/09/04に公開

この記事について

この記事は、Shopify CLI command reference (Ruby on Rails) の記事を和訳したものです。

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

このリファレンスでは、Shopify CLI で使用できる Ruby on Rails のコマンドをリストアップしています。このグループのコマンドは、構文 shopify rails [command]を使用します。

コマンドラインからこれらのコマンドのヘルプにアクセスするには、shopify rails [command] -h を使います。

既存の Shopify CLI プロジェクトを、[パートナーアカウント](Partner account)または特定の Shopify開発ストアに接続します。

connectコマンドは、プロジェクトの.envと.shopify-cli.ymlファイルが存在しない場合は再作成し、存在する場合はファイルを更新します。

.env には、アプリキーなど、アプリに機能を提供するための機密情報が含まれています。そのため、このファイルはバージョンコントロールシステムに保存すべきではありません。
shopify-cli.yml には、プロジェクトタイプのように、プロジェクトが Shopify CLI で動作するために必要な機密性のない情報が含まれています。

このコマンドは、複数のコンピュータで 1 つのプロジェクトに取り組んでいる場合や、Git のようなバージョンコントロールシステムを使って他の開発者と共同作業をしている場合に便利です。

shopify rails connect

指定されたタイプの新しいプロジェクトを作成します。プロジェクトは、現在のディレクトリのサブディレクトリに作成されます。

shopify rails create

Shopify CLI は次に、プロジェクトの名前を入力するよう求めます。

shopify rails create
? App Name
>

現在の Rails アプリをホスティングサービスにデプロイします。現在は、Herokuしか選択肢がありません。

shopify rails deploy heroku

アプリのプロジェクト内にボイラープレートコードを生成します。Rails プロジェクトでは、新しいwebhooksの生成に対応しています。

shopify rails generate webhook

ローカルの開発アプリをデフォルトのブラウザで開きます。

shopify rails open

プロジェクト用のローカル開発サーバーと、ローカルホストへの公開 ngrok トンネルを開始します。

shopify rails serve

ngrok を使用して、ローカル開発アプリへの HTTP トンネルを制御します。tunnelコマンドでは、ngrok との認証やトンネルの開始・停止を行うことができます。

ngrok で認証を行うには、認証トークンが必要です。トークンは ngrok のダッシュボードにあります。そのトークンをコピーして、tunnel [project type] auth コマンドで使用します。

shopify rails tunnel auth <token>

これで ngrok の auth トークンが ~/.ngrok2/ngrok.yml に書き込まれます。ngrok の設定についての詳細は、ngrok のドキュメントを参照してください。

localhost の開発環境でアプリへの ngrok トンネルを開始するには、以下の手順に従います。

shopify rails tunnel start

実行中の ngrok トンネルを停止するには、次のようにします。

shopify rails tunnel stop

ログインするとコメントできます