Welcome

A full-stack Shopify custom app starter kit.

Brush is a starter kit for building Shopify custom apps. Based on gadget.dev for the backend and a ViteJS app embedding AlpineJS for the frontend.

For your gadget.dev app

Get valuable enhancements that help build a powerful backend to add custom features to your Shopify shop.

For your Shopify theme

Include a bundled and optimized JS app in your Shopify theme using the lightweight AlpineJS frontend framework for modern development and reactivity.

Seamless communication

Easily make authenticated RESTful API calls from your Shopify theme to your gadget.dev backend while ensuring proper localization.

A set of must-have features

Full Typescript

Both the frontend and backend apps leverage Typescript for modern and bugless development.

Stateful frontend context

Synchronized cross-browser-tabs stateful context based on AlpineJS stores and persist plugin.

Fetch wrapper

Optimized frontend fetcher to cope with Shopify App Proxy’s authenticated requests and ensuring shop’s market consistency.

i18n

A single source of thuth: Shopify’s theme JSON translation files are converted to i18Next dictionnaries available in the frontend and backend.

Browser cache management

Ensuring up-to-date frontend app thanks to automatic update following Shopify’s assets versioning.

Precognitive forms

A powerful frontend form validator requesting server-side validation using Zod. A single submission process to validate and submit forms.

Quality of life

Handling referrers, custom Shopify post login redirection, price formatting, …

Admin and Storefront APIs

Out-of-the-box Admin and Storefront Shopify GraphQL APIs clients that are ready to use.

RESTful API

Using gadget.dev’s routes so that the frontend app can make secured requests to the backend.

More-or-less soon to come

Persistent configuration

Storing custom shop-based configurations in gadget.dev’s DB.

Slugifier

Always useful to be able to convert text to a standardized handle-like format.

Customer API

Adding the Shopify’s Customer GraphQL API to the backend app.

ID ↔ GID converted

A quick tool to easily switch from numbered ID to Shopify resources GIDs. And vice-versa.