Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/trafilea/nx-shopify

Nx plugin for developing performance-first Shopify themes 🚀
https://github.com/trafilea/nx-shopify

ecommerce nx nx-plugin nx-shopify nx-workspace shopify shopify-themes themekit trafilea

Last synced: 14 days ago
JSON representation

Nx plugin for developing performance-first Shopify themes 🚀

Awesome Lists containing this project

README

        



Nx-Shopify

[![e2e](https://github.com/trafilea/nx-shopify/actions/workflows/e2e.yml/badge.svg)](https://github.com/trafilea/nx-shopify/actions/workflows/e2e.yml)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![License](https://img.shields.io/github/license/trafilea/nx-shopify)](https://github.com/trafilea/nx-shopify/blob/master/LICENSE)
[![npm (scoped)](https://img.shields.io/npm/v/@trafilea/nx-shopify)](https://www.npmjs.com/package/@trafilea/nx-shopify)
[![npm](https://img.shields.io/npm/dt/@trafilea/nx-shopify)](https://www.npmjs.com/package/@trafilea/nx-shopify)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)

> 🔎 **An [Nx](https://nx.dev) 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


## Getting Started

Install the Nx CLI globally

```
# npm
$ npm install --global nx

# yarn
$ yarn add --global nx

# pnpm
$ pnpm install --global nx
```

Create an empty Nx workspace (or use an existing one)

```
$ npx create-nx-workspace my-org --preset=empty
$ cd ./my-org
```

Install the Nx-Shopify plugin as a devDependency

```
# npm
$ npm install --save-dev @trafilea/nx-shopify

# yarn
$ yarn add --save-dev @trafilea/nx-shopify

# pnpm
$ pnpm install --save-dev @trafilea/nx-shopify
```

Generate a Shopify theme using the Nx CLI

```
$ nx generate @trafilea/nx-shopify:theme my-theme
```

Check the generators and executors provided by the plugin

```
$ nx list @trafilea/nx-shopify
```

## Documentation

- 🤓 Read the full documentation on the [docs site](https://trafilea.github.io/nx-shopify)
- 👀 Checkout the [examples workspace](https://github.com/trafilea/nx-shopify-examples)

## Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):



Sebastian Duque Gutierrez

💻 🚇 🤔 📝 📖

Karen Santana

💻 🤔

Andisa Diaz

💻

Mauricio Vuljevas

🤔

Jesus Salinas Vela

🤔 📆

Sophie

📆

Jibin Mathew

💻 🐛

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!