gadget-best-practices

Category: Tools & Productivity | Uploader: gadget-inc | Downloads: 0 | Version: v1.0（Latest）

Best practices for building with Gadget. Use when developers need guidance on models, actions, routes, access control, Shopify/BigCommerce integrations, frontend patterns, API usage, testing setup, CI verification, ggt workflows, debugging, or parallel agent development loops. Triggers "model", "action", "route", "permission", "access control", "multi-tenancy", "Shopify", "BigCommerce", "frontend", "API client", "internal API", "filter", "sort", "pagination", "webhook", "background job", "testing", "ci", "ggt", "debugger", "logs", "problems

Changelog: Source: GitHub https://github.com/gadget-inc/skills

Directory Structure

Current level: tree/main/skills/gadget/gadget-best-practices/

📁 references/
- 📄 access-control.md 8.6 KB
- 📄 actions.md 7.8 KB
- 📄 api-client.md 7.0 KB
- 📄 authentication.md 7.1 KB
- 📄 background-jobs.md 6.8 KB
- 📄 bigcommerce-integration.md 4.9 KB
- 📄 data-access.md 6.8 KB
- 📄 deployment.md 3.4 KB
- 📄 environments.md 2.4 KB
- 📄 error-codes.md 3.8 KB
- 📄 fields.md 8.8 KB
- 📄 frontend-components.md 1.6 KB
- 📄 frontend-forms.md 2.2 KB
- 📄 frontend-hooks.md 4.8 KB
- 📄 ggt-cli.md 8.7 KB
- 📄 internal-api.md 2.9 KB
- 📄 models.md 10.9 KB
- 📄 project-structure.md 3.6 KB
- 📄 relationships.md 4.8 KB
- 📄 routes.md 4.7 KB
- 📄 shopify-integration.md 7.0 KB
- 📄 shopify-multi-tenancy.md 6.4 KB
- 📄 testing.md 6.5 KB
- 📄 webhooks.md 8.3 KB
📄 SKILL.md 3.6 KB

SKILL.md

---
name: gadget-best-practices
description: Best practices for building with Gadget. Use when developers need guidance on models, actions, routes, access control, Shopify/BigCommerce integrations, frontend patterns, API usage, testing setup, CI verification, ggt workflows, debugging, or parallel agent development loops. Triggers "model", "action", "route", "permission", "access control", "multi-tenancy", "Shopify", "BigCommerce", "frontend", "API client", "internal API", "filter", "sort", "pagination", "webhook", "background job", "testing", "ci", "ggt", "debugger", "logs", "problems"
---

## How to use

This skill provides quick reference patterns and best practices for building with Gadget.

**📖 Resources:**
- Full documentation: [docs.gadget.dev](https://docs.gadget.dev)

Read individual rule files for detailed explanations and code examples:

### Core Data Modeling
- [references/models.md](references/models.md) - Data model design patterns and naming conventions
- [references/fields.md](references/fields.md) - Field types, validations, and configuration
- [references/relationships.md](references/relationships.md) - Relationship patterns (belongsTo, hasMany, hasManyThrough)
- [references/data-access.md](references/data-access.md) - Computed views and computed fields (Gelly aggregates, group by, time-series, access control)

### Backend Logic
- [references/actions.md](references/actions.md) - Model actions vs global actions, hooks, and patterns
- [references/routes.md](references/routes.md) - HTTP routes and when to use them vs actions
- [references/background-jobs.md](references/background-jobs.md) - Enqueueing actions and scheduled tasks

### Access Control & Security
- [references/access-control.md](references/access-control.md) - RBAC, permission filters, and Gelly expressions
- [references/shopify-multi-tenancy.md](references/shopify-multi-tenancy.md) - Shop isolation patterns for Shopify apps

### Platform Integrations
- [references/shopify-integration.md](references/shopify-integration.md) - Shopify app patterns (webhooks, sync triggers, metafields)
- [references/bigcommerce-integration.md](references/bigcommerce-integration.md) - BigCommerce app patterns
- [references/webhooks.md](references/webhooks.md) - Webhook handling patterns

### Frontend Development
- [references/frontend-hooks.md](references/frontend-hooks.md) - React hooks from @gadgetinc/react
- [references/frontend-components.md](references/frontend-components.md) - Autocomponents and UI patterns
- [references/frontend-forms.md](references/frontend-forms.md) - Form handling and validation

### Development Workflow
- [references/ggt-cli.md](references/ggt-cli.md) - Canonical ggt workflow (sync, checks, logs, envs, conflict handling, parallel worktrees)
- [references/testing.md](references/testing.md) - Framework-agnostic testing setup, scenarios, and CI gates
- [references/deployment.md](references/deployment.md) - Deployment workflows and environments
- [references/environments.md](references/environments.md) - Environment variables and multi-environment strategies
- [references/project-structure.md](references/project-structure.md) - File organization and conventions

### API & Authentication
- [references/api-client.md](references/api-client.md) - Using the Gadget API client (filters, pagination, relationships)
- [references/internal-api.md](references/internal-api.md) - Internal API usage, atomic updates, transaction-safe writes, and admin/session context
- [references/authentication.md](references/authentication.md) - User authentication patterns
- [references/error-codes.md](references/error-codes.md) - Common Gadget API error codes, likely causes, and triage workflow

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

gadget-best-practices

Directory Structure

SKILL.md

Report

Notice