https://github.com/bkwld/cloak-customer
Nuxt pages and components for Shopify customer account management.
https://github.com/bkwld/cloak-customer
cloak-package nuxt shopify
Last synced: 2 months ago
JSON representation
Nuxt pages and components for Shopify customer account management.
- Host: GitHub
- URL: https://github.com/bkwld/cloak-customer
- Owner: BKWLD
- License: mit
- Created: 2022-04-01T19:49:47.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-15T22:11:42.000Z (almost 4 years ago)
- Last Synced: 2025-07-12T04:42:23.933Z (about 1 year ago)
- Topics: cloak-package, nuxt, shopify
- Language: Vue
- Homepage:
- Size: 548 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @cloak-app/customer
Cloak components for rendering Customer components.
- [View demo](https://cloak-customer.netlify.app)
- [Edit CodeSandbox](https://githubbox.com/BKWLD/cloak-customer)
## 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
5. Make sure accounts are at least set to optional on the shop (/admin/settings/checkout)
6. 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
- ``
### 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