Skip to main content

Introduction

Nx-Shopify

๐Ÿ”Ž A Nx plugin for developing performance-first Shopify themes ๐Ÿš€

Be it you need to build a custom Shopify store theme, develop a generic theme or even maintain multiple stores/themes with shared code across them, this Nx plugin helps you power-up your development experience


e2e Commitizen friendly License npm (scoped) npm semantic-release code style: prettier

This Nx Plugin for Shopify contains generators and executors for managing Shopify themes within an Nx workspace. It provides:

  • Support for writing themes using TypeScript.
  • Out of the box code formatting using Prettier and ESLint.
  • Scaffolding for creating new themes with separate configs.
  • Scaffolding for creating theme block suchs as layouts, templates, sections and snippets.
  • Utilities for working with different application environments & themekit environments.

Get stared#

You can quickly jump in with the following commands:

$ npx create-nx-workspace my-org --preset=empty
$ cd ./my-org
$ npm i -D @trafilea/nx-shopify
$ nx g @trafilea/nx-shopify:theme my-theme
# Configure your apps/my-theme/config.yml file
$ nx serve my-theme
$ nx build my-theme
$ nx deploy my-theme

Read more about everything that comes with Nx-Shopify in our documentation.