@cloak-app/customer

1.0.0 • Public • Published

@cloak-app/customer

Cloak components for rendering Customer components.

Install

  1. Install with yarn add @cloak-app/customer
  2. Add to nuxt.config with buildModules: ['@cloak-app/customer']
  3. Make sure components is set to true in the project's nuxt.config so the components can be auto-loaded
  4. Set Shopify admin api permissions
  • create a private 'develop' app
  • allow admin api access & allow permission to
  • write_customers
  • read_customers
  1. Make sure accounts are at least set to optional on the shop (/admin/settings/checkout)
  2. Redirect account pages to the nuxt site (this will need to be placed either in shopify-theme/main.coffee or shopify-theme/plugins/routing.coffee)
# Redirect account pages to www site
if match = location.pathname.match /^\/(account)/
then location.href = makeNuxtUrl location.pathname

Options

  • cloak.customer:
    • authenticatedRoute - The route to redirect users who aren't authenticated. Defaults to /account
    • unauthenticatedRoute - The route to redirect users who aren't authenticated. Defaults to /account/login
    • layout - The Nuxt layout to use within the customer pages. Defaults to default.

Expected project components

  • <btn>

Expected Styus vars

  • radius
  • spacing (xs - xxl)
  • ui-grey
  • primary-color
  • ui-error
  • tablet-up() and tablet-down() breakpoint helpers

Expected ENV vars

  • SHOPIFY_URL
  • APP_ENV
  • SHOPIFY_STOREFRONT_TOKEN

Module Options

Components

Readme

Keywords

none

Package Sidebar

Install

npm i @cloak-app/customer

Weekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

78.7 kB

Total Files

61

Last publish

Collaborators

  • isaazgarcia
  • lemoswilson
  • mattaebersold
  • brokenhd
  • sjstark
  • weotch