Back to Details

gadget-best-practices

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

How to use

使用方法

This skill provides quick reference patterns and best practices for building with Gadget.
📖 Resources:
Read individual rule files for detailed explanations and code examples:
本技能提供了使用Gadget进行开发的快速参考模式和最佳实践。
📖 资源：
阅读单个规则文件以获取详细说明和代码示例：

Core Data Modeling

核心数据建模

  • references/models.md - Data model design patterns and naming conventions
  • references/fields.md - Field types, validations, and configuration
  • references/relationships.md - Relationship patterns (belongsTo, hasMany, hasManyThrough)
  • references/data-access.md - Computed views and computed fields (Gelly aggregates, group by, time-series, access control)
  • references/models.md - 数据模型设计模式与命名规范
  • references/fields.md - 字段类型、验证与配置
  • references/relationships.md - 关联模式（belongsTo、hasMany、hasManyThrough）
  • references/data-access.md - 计算视图与计算字段（Gelly聚合、分组、时间序列、访问控制）

Backend Logic

后端逻辑

  • references/actions.md - Model actions vs global actions, hooks, and patterns
  • references/routes.md - HTTP routes and when to use them vs actions
  • references/background-jobs.md - Enqueueing actions and scheduled tasks
  • references/actions.md - 模型操作 vs 全局操作、钩子与模式
  • references/routes.md - HTTP路由以及何时使用路由而非操作
  • references/background-jobs.md - 入队操作与定时任务

Access Control & Security

访问控制与安全

  • references/access-control.md - RBAC, permission filters, and Gelly expressions
  • references/shopify-multi-tenancy.md - Shop isolation patterns for Shopify apps
  • references/access-control.md - RBAC、权限过滤器与Gelly表达式
  • references/shopify-multi-tenancy.md - Shopify应用的店铺隔离模式

Platform Integrations

平台集成

  • references/shopify-integration.md - Shopify app patterns (webhooks, sync triggers, metafields)
  • references/bigcommerce-integration.md - BigCommerce app patterns
  • references/webhooks.md - Webhook handling patterns
  • references/shopify-integration.md - Shopify应用模式（webhook、同步触发器、元字段）
  • references/bigcommerce-integration.md - BigCommerce应用模式
  • references/webhooks.md - Webhook处理模式

Frontend Development

前端开发

  • references/frontend-hooks.md - React hooks from @gadgetinc/react
  • references/frontend-components.md - Autocomponents and UI patterns
  • references/frontend-forms.md - Form handling and validation
  • references/frontend-hooks.md - 来自@gadgetinc/react的React钩子
  • references/frontend-components.md - 自动组件与UI模式
  • references/frontend-forms.md - 表单处理与验证

Development Workflow

开发工作流

  • references/ggt-cli.md - CLI commands for adding models, fields, actions, and routes
  • references/deployment.md - Deployment workflows and environments
  • references/environments.md - Environment variables and multi-environment strategies
  • references/project-structure.md - File organization and conventions
  • references/ggt-cli.md - 用于添加模型、字段、操作和路由的CLI命令
  • references/deployment.md - 部署工作流与环境
  • references/environments.md - 环境变量与多环境策略
  • references/project-structure.md - 文件组织与规范

API & Authentication

API与认证

  • references/api-client.md - Using the Gadget API client (filters, pagination, relationships)
  • references/authentication.md - User authentication patterns
  • references/api-client.md - 使用Gadget API客户端（过滤器、分页、关联）
  • references/authentication.md - 用户认证模式