gadget-best-practices について
Gadget でアプリを開発する人向けのリファレンススキルです。データモデリング、バックエンド、セキュリティ、連携、フロントエンド、開発ワークフロー、API、認証を扱います。
主な機能
- 01データモデル、フィールド、リレーション
- 02アクション、ルート、バックグラウンドジョブ
- 03アクセス制御とセキュリティのパターン
- 04Shopify と BigCommerce の連携ガイド
- 05React のフック、コンポーネント、フォーム
- 06API、認証、テスト、デプロイ
活用シーン
- 01Gadget のデータモデルとリレーションの設計
- 02バックエンドのアクションとルートの実装
- 03Shopify または BigCommerce アプリ機能の開発
- 04テストとデプロイのワークフロー設定
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ gadget-inc/ skills --skill gadget-best-practicesインストール後、Claude Code で/gadget-best-practicesを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/access-control.mdactions.mdapi-client.mdauthentication.mdbackground-jobs.mdbigcommerce-integration.mddata-access.mddeployment.mdenvironments.mderror-codes.mdfields.mdfrontend-components.mdfrontend-forms.mdfrontend-hooks.mdggt-cli.mdinternal-api.mdmodels.mdproject-structure.mdrelationships.mdroutes.mdshopify-integration.mdshopify-multi-tenancy.mdtesting.mdwebhooks.md詳細
使用方法
このスキルでは、Gadget を使った開発に役立つクイックリファレンスのパターンとベストプラクティスを紹介します。
📖 リソース:
- ドキュメント全文:docs.gadget.dev
詳しい説明とコード例については、各ルールファイルを参照してください。
コアデータモデリング
- references/models.md - データモデルの設計パターンと命名規則
- references/fields.md - フィールドの種類、検証、設定
- references/relationships.md - リレーションシップのパターン(belongsTo、hasMany、hasManyThrough)
- references/data-access.md - 計算ビューと計算フィールド(Gelly の集計、グループ化、時系列、アクセス制御)
バックエンドロジック
- references/actions.md - モデルアクションとグローバルアクション、フック、各種パターン
- references/routes.md - HTTP ルートと、アクションの代わりにルートを使うケース
- references/background-jobs.md - アクションのキューへの登録とスケジュールタスク
アクセス制御とセキュリティ
- references/access-control.md - RBAC、権限フィルター、Gelly 式
- references/shopify-multi-tenancy.md - Shopify アプリにおけるショップ分離のパターン
プラットフォーム連携
- references/shopify-integration.md - Shopify アプリのパターン(Webhook、同期トリガー、メタフィールド)
- references/bigcommerce-integration.md - BigCommerce アプリのパターン
- references/webhooks.md - Webhook の処理パターン
フロントエンド開発
- references/frontend-hooks.md - @gadgetinc/react の React フック
- references/frontend-components.md - オートコンポーネントと UI パターン
- references/frontend-forms.md - フォームの処理と検証
開発ワークフロー
- references/ggt-cli.md - 標準的な ggt ワークフロー(同期、チェック、ログ、環境、競合処理、並列ワークツリー)
- references/testing.md - フレームワークに依存しないテスト環境の設定、シナリオ、CI ゲート
- references/deployment.md - デプロイのワークフローと環境
- references/environments.md - 環境変数と複数環境の運用戦略
- references/project-structure.md - ファイル構成と規則
API と認証
- references/api-client.md - Gadget API クライアントの使用方法(フィルター、ページネーション、リレーションシップ)
- references/internal-api.md - 内部 API の使用方法、アトミック更新、トランザクションセーフな書き込み、管理者/セッションコンテキスト
- references/authentication.md - ユーザー認証のパターン
- references/error-codes.md - Gadget API の一般的なエラーコード、考えられる原因、トリアージのワークフロー
コメント
Markdown 対応