gadget-best-practices

Name: gadget-best-practices
Author: gadget-inc

github.com/gadget-incDevelopment8259 installsUpdated 14w ago

About gadget-best-practices

A reference skill for developers building applications with Gadget. It organizes guidance across data modeling, backend logic, security, integrations, frontend work, development workflows, APIs, and authentication.

Key features

01Data models, fields, and relationships
02Actions, routes, and background jobs
03Access control and security patterns
04Shopify and BigCommerce integration guidance
05React frontend hooks, components, and forms
06API, authentication, testing, and deployment

Use cases

01Design Gadget data models and relationships
02Implement backend actions and routes
03Build Shopify or BigCommerce app features
04Set up testing and deployment workflows

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/gadget-inc/skills --skill gadget-best-practices

After installing, type/gadget-best-practicesin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/

access-control.md

actions.md

api-client.md

authentication.md

background-jobs.md

bigcommerce-integration.md

data-access.md

deployment.md

environments.md

error-codes.md

fields.md

frontend-components.md

frontend-forms.md

frontend-hooks.md

ggt-cli.md

internal-api.md

models.md

project-structure.md

relationships.md

routes.md

shopify-integration.md

shopify-multi-tenancy.md

testing.md

webhooks.md

Details

From the project README

How to use

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

📖 Resources:

Full documentation: docs.gadget.dev

Read individual rule files for detailed explanations and code examples:

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)

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

Access Control & Security

references/access-control.md - RBAC, permission filters, and Gelly expressions
references/shopify-multi-tenancy.md - Shop isolation patterns for Shopify apps

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

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

Development Workflow

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

API & Authentication

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

Comments

Markdown supported

Details

Author: gadget-inc
Repository: gadget-inc/skills
Category: Development
Installs: 259
GitHub stars: 8

Report

More skills

All skills

remotion-render

github.com/inference-sh

1.6M

Render videos from React/Remotion component code via inference.sh. Pass TSX code, get MP4. Supports all Remotion APIs: useCurrentFrame, useVideoConfig, spring, interpolate, AbsoluteFill, Sequence. Configurable resolution, FPS, duration, codec. Use for: programmatic video generation, animated graphics, motion design, data-driven videos, React animations to video. Triggers: remotion, render video from code, tsx to video, react video, programmatic video, remotion render, code to video, animated video, motion graphics code, react animation video

improve-codebase-architecture

github.com/mattpocock

1.2M

Scan a codebase for architecture improvement opportunities, present them as a visual HTML report, then dive deep into whichever one you pick.

design-mobile-apps

github.com/designed-by-ai

1.2M

Design mobile app screens with Sleek, edit Sleek projects, and implement their designs in React Native or HTML

vercel-react-best-practices

github.com/vercel-labs

867.3k

React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.