Skip to content

Shopify app template with NX, Nest, React and TypeScript

Notifications You must be signed in to change notification settings

rostyk-begey/shopify-app-template

Repository files navigation

Shopify App Template | NX - Nest - React Vite

This is a template for embedded Shopify apps.
Build on top of NX with Nest as a server framework and React with Vite as frontend option.

Found a bug? Please create an issue! ❤️

Table of Contents

  • ✨ Features
  • 👀 Requirements
  • 🤓 Getting Started

✨ Features

  • 📝 TypeScript
  • 🦾 NX - Smart, Fast and Extensible Build System
  • Nest - A progressive Node.js framework
  • 🥷 React with Vite
  • 💫 React Query
  • 📄 File based routing
  • 🔑 Works with Shopify CLI 3.0
  • 📦️ Dockerfile
  • 🚨 Code quality tools
    • eslint
    • prettier
    • commitlint
    • lintstaged
    • husky with pre-commit and commit-msg hooks

👀 Requirements

  • Shopify Partner Account
  • Shopify Dev Store
  • Ngrok account

🤓 Getting Started

  • Click Use this template or this link
  • Create an App in your Shopify Partner Account
  • Fill out your shopify.app.toml file
    • name: The Shopify App name
    • scopes: The access scopes your app needs
  • Run yarn install
  • Run yarn start
  • Your apps ngrok url will be printed to the terminal
  • Install the app to your dev store