Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/brob/page-builder-demo

Last synced: 7 days ago
JSON representation

Host: GitHub
URL: https://github.com/brob/page-builder-demo
Owner: brob
License: mit
Created: 2021-03-19T18:08:28.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2023-12-15T17:38:17.000Z (about 1 year ago)
Last Synced: 2024-11-07T00:29:42.910Z (about 2 months ago)
Language: JavaScript
Homepage: page-builder-demo-brob.vercel.app
Size: 14.8 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

Headless Shopify starter built on Next.js 🤘

Headless CMS powered by Sanity.io ⚡

Features •
Tours •
Set Up •
Spin Up •
Deployment •
Extras

# ✨ Features
🟢 **= implemented** /
🟡 **= in progress** /
⚪ **= not started**

---

- 🟢 utility-first CSS with [Tailwind CSS](https://tailwindcss.com)
- 🟢 Page Transitions powered by [Framer Motion](https://www.framer.com/motion/)
- 🟢 Cart powered by [Shopify Buy SDK](https://www.npmjs.com/package/shopify-buy)
- 🟢 Klaviyo Waitlist form for out-of-stock Products + Variants
- 🟢 Klaviyo Newsletter form with opt-in feature _(with validation and success/failure states)_
- 🟢 Contact Form with email notifications powered by SendGrid _(with validation and success/failure states)_
- 🟢 Dynamic Page Routes with optional nesting _(ie. `/parent/child`)_
- 🟢 Automatic `Sitemap.xml` generation
- 🟢 Automatic `robots.txt` generation
- 🟢 Automatic 301 Redirects from Sanity
- 🟢 Live Preview content directly from Sanity
- 🟢 Dynamic Modules for building page content, including:
- 🟢 Marquees
- 🟢 Image Galleries/Carousels
- 🟢 Accordions
- 🟢 Pull-out Drawers
- 🟢 Cursor Follows
- 🟡 Product Carousels
- ⚪ Instagram Feed
- 🟢 Baseline styles using extracted component classes for cleaner code
- 🟢 Simple Social icon navigation lists
- 🟢 Lazyload Images + WEBP format by default
- 🟡 Promotion Banner
- ⚪ Default Blog setup
- ⚪ Initial animations
- ⚪ Scroll animations
- 🟢 Accessibility features:
- 🟢 ARIA Landmark Roles
- 🟢 Default focus states preserved for keyboard navigation
- 🟢 Correctly Trap focus when Drawers are open with [focus-trap-react](https://www.npmjs.com/package/focus-trap-react)
- 🟢 Input-based Counters
- 🟢 Correctly associated button states
- 🟢 Required `alt` states for all images
- 🟢 Skip to Content link
- 🟢 SEO features:
- 🟢 Page-level SEO/Share settings with previews
- 🟢 Fallback Global SEO/Share settings
- 🟢 Automatic JSON-LD Schema markup for Products

### Headless Shopify
- 🟢 Syncs Products from Shopify into Sanity
- 🟢 Tracks product status _(draft/published)_ from Shopify to help control visibility while editing
- 🟢 Automatic Variant option toggles
- 🟢 Marks deleted products and variants for easy tracking
- 🟢 SSR (Dynamic Rendering) of PDP pages
- 🟢 Updates the URL on variant changes while keeping a clean history stack
- 🟢 Accessible and clamped Quantity Counters
- 🟢 Vanity Shop URL Masking
- 🟢 Global Cart with access to all variant data for line items
- 🟢 Supports Single Variant products out of the box
- 🟢 PDP Photo Galleries with variant granularity
- 🟢 default PLP for all products
- 🟢 Custom PLPs with easy, Sanity-managed Collections
- 🟢 Ability to surface a PDP option on PLP product cards
- 🟡 Sanity-managed conditional Cart "add-ons"
- ⚪ Ability to apply coupons to the checkout cart
- ⚪ Account Management _(register/login/password/orders)_
- ⚪ Customer Reviews Integration _(Yotpo? Okendo? Junip?)_

# 🎧 Tours
Still not sold? Here's some videos to get you psyched:

**Famous 5-Minute Setup™ - `Coming Soon`**

_From sync to sale, watch me spin up a fresh storefront in under 5 minutes!_

**Explore the file Structure - `Coming Soon`**

_In-depth look at the file structure, naming conventions, and logic under the hood_

**Setting up your first Product - `Coming Soon`**

_Explore the Product settings within Sanity and how to properly setup PDP pages and PLP cards_

**Connecting to Klaviyo and testing your Forms - `Coming Soon`**

_Learn how to quickly connect Klaviyo to utilize product waitlist and newsletter forms_

**Setup your first Vercel deployment - `Coming Soon`**

_Using the Sanity Vercel Deploy plugin, see how easy it is to empower your clients to trigger deploys_

# 💀 Set Up

Clone this repository from your GitHub account with the `use template` button

### 1) Sanity
1. `npm install && sanity init` in the `/studio` folder
2. During Sanity's initalization it will warn you, type `Y` and hit `enter`:
```
? The current folder contains a configured Sanity studio. Would you like to reconfigure it? (Y/n)
```
3. When it asks you what dataset configuration to use, go with the `default`
4. Add CORS Origins to your newly created Sanity project (visit: [manage.sanity.io](https://manage.sanity.io) and go to Settings > API):
- Add your Studio URLs **_with_** credentials: `http://localhost:3333` and `[subdomain].sanity.studio`
- Add your front-end URLs **_without_** credentials: `http://localhost:3000` and `https://[subdomain].vercel.app`
> ⚠️ **Note**
This Studio uses the new "actions" resolver to handle "singleton" documents. To adjust what documents should behave like singletons be sure to edit the `singletons` array in the following file: `/studio/parts/resolve-actions.js`

### 2) Shopify Storefront Access
1. Enable Private Apps in Shopify
- Apps > "Manage Private Apps" *(text link in page footer)*
- Enable Private Apps
2. Create new Private App
- Apps > Manage Private Apps > "Create private app"
- Give this a relevant name, I prefer: "Headless Storefront", so it's clear what it's being used for
- Use your dev email to know when there are issues
- Change Admin API permissions on "Products" to `Read and write`
- Allow this app to access your storefront data using the Storefront API, with at least the following permissions:
- Read inventory of products and their variants
- Read and modify checkouts

### 3) Shopify Webhooks
1. Go to "Settings" *(bottom left)* -> "Notifications" -> "Webhooks" *(very bottom)*
2. add the following webhooks:
- product update - `[your-domain]/api/shopify/product-update`
- product deletion - `[your-domain]/api/shopify/product-delete`
> ⚠️ **Note**
You have to use a real domain name (no localhost). Be sure to use your Vercel project URL during development, and then switch to the production domain once live. You won't know your Vercel project domain until you deploy in a later step, just enter in what you think it will be for now!

### 4) NextJS
1. `npm install` in the project root folder on local
2. Create an `.env.local` file in the project folder, and add the following variables:
```
SANITY_PROJECT_DATASET=production
SANITY_PROJECT_ID=XXXXXX
SANITY_API_TOKEN=XXXXXX
SHOPIFY_STORE_ID=XXXXXX
SHOPIFY_API_TOKEN=XXXXXX
SHOPIFY_API_PASSWORD=XXXXXX
SHOPIFY_WEBHOOK_INTEGRITY=XXXXXX

// Needed for Klaviyo forms:
KLAVIYO_API_KEY=XXXXXX

// Needed for Mailchimp forms:
MAILCHIMP_API_KEY=XXXXXX-usX
MAILCHIMP_SERVER=usX

// Needed for SendGrid forms:
SENDGRID_API_KEY=XXXXXX
```
3. Update all the `XXXXXX` values, here's where to find each:
- `SANITY_PROJECT_ID` - You can grab this after you've initalized Sanity, either from the `studio/sanity.json` file, or from your Sanity Manage dashboard
- `SANITY_API_TOKEN` - Generate an API token for your Sanity project. Access your project from the Sanity Manage dashboard, and navigate to: "Settings" -> "API" -> "Add New Token" button. Make sure you give `read + write` access!
- `SHOPIFY_STORE_ID` - This is your Shopify store ID, it's the subdomain behind `.myshopify.com`
- `SHOPIFY_API_TOKEN` - Copy the Storefront Access Token you copied from setting up your Private Shopify App. _(Note: This is **not** the Admin API Key, scroll to the bottom where it says "Storefront API" for the correct value)_
- `SHOPIFY_API_PASSWORD` - Copy the Admin API password from "Apps" -> "Manage private apps" -> [your_private_app].
- `SHOPIFY_WEBHOOK_INTEGRITY` - Copy the Integrity hash from "Settings" -> "Notifications" -> "Webhooks" *(very bottom of page)*
- `KLAVIYO_API_KEY` - This is your Public API Key / Site ID from your Klaviyo Account "Settings" -> "API Keys"
- `MAILCHIMP_API_KEY` - Create an API key from "Account -> "Extras" -> API Keys
- `MAILCHIMP_SERVER` - This is the server your account is from. It's in the URL when logged in and at the end of your API Key
- `SENDGRID_API_KEY` - Create an API key from "Settings" -> "API Keys" with "Restricted Access" to only "Mail Send"

### 5) Shopify Store Theme
Since we're serving our store through a headless environment, we don't want visitors accessing our unused shopify theme. The domain for this is visible during checkout, and is publicly accessible. To silence it, replace your current theme's `theme.liquid` file with the one from this repo, and replace `your_frontsite_domain` with your actual frontsite domain URL **(do not include protocol or trailing slash)**

This will essentially "pass-through" URLs accessed at your Shopify Store to your true headless storefront *(ie. `shop.hull.com/products` -> `hull.com/products`)*

# ⚡ Spin Up

### Next (Front End)
`npm run dev` in the project folder to start the front end locally
- Your front end should be running on [http://localhost:3000](http://localhost:3000)

### Sanity (Back End)
`sanity start` in the `/studio` folder to start the studio locally
- Your Sanity Studio should be running on [http://localhost:3333](http://localhost:3333)

# 🚀 Deployment

### Vercel
This is setup to work seamlessly with Vercel, which I highly recommend as your hosting provider of choice. Simply follow the on-screen instructions to setup your new project, and be sure to **add the same `.env.local` variables to your Vercel Project**

### Sanity
This is an easy one, you can simply run `sanity deploy` from the `/studio` folder in your project. Select a subdomain you want; your Studio is now accessible from the web. This is where I'll invite the client to manage the project so they can both add billing info and begin editing content.

### Client Updates
Once you hand off to the client you'll want to give them the ability to generate builds when they make updates within the Sanity Studio. The easiest way to do this is through my [Vercel Deploy plugin](https://github.com/ndimatteo/sanity-plugin-vercel-deploy).

# 🤘 Extras/Tips

This looks like a theme... How can I use this like a starter?

While this starter is relatively opinionated, the goal was three-fold:
1. Use high-quality packages that don't get in the way
2. Solve common UX problems and complex logic so you can focus on the fun stuff
3. Create a more approachable starter for anyone looking to build production-ready headless Shopify experiences

That being said, I understand this means a lot of what's included is **very opinionated**. However, you'll find that at it's core the structure and naming conventions lend itself to really making it your own.

By now, I'm sure you noticed the ridiculous-looking [demo site](https://insane.codes/) (I love 90's metal, can you tell?)

I've purposefully used extracted component classes, not only for cleaner file structure, but also so you can easily work in your own styles exclusively within the styles folder. Feel free to extend our outright remove the applied styles for all the components!

What's up with the CSS? What are extracted component classes and why should I use them?

While utility-first CSS definitely speeds up your dev time, it can become overwhelming and untenable. This can make it difficult to understand what a component is doing when shrouded in dozens of utility classes, especially for developers getting familiar with a new codebase. Luckily, Tailwind offers the ability to [extract a component](https://tailwindcss.com/docs/extracting-components), allowing you to compose custom utility patterns.

The nice thing about this is we can get all the benefits of writing in utility class shorthand, but without having to sift through all your javascript logic to adjust styles. This means writing our CSS is business as usual. You create stylesheets, but use Tailwind's `@apply` to create nice and succinct classes to push to your components.

You still get all the tree-shaking benefits of Tailwind, _and_ you can still use utility classes in your components when needed; the best of both worlds!

Can I use this for non-Shopify projects?

Absolutely! This starter was actually born out of a non-shopify starter I had been using for my own client projects. Simply delete the shopify-specific logic and you've got yourself a fancy static starter powered by Next and Sanity!

Here's a shortlist of what to remove:
- Within the `/components` folder, remove `cart`, `product`, and `shop` folders
- Within the `/pages/api` folder, remove `products` and `shopify` folders
- Within the `/pages` folder, remove `products` and `shop` folders
- Within the `_app.js` file, remove `` and `` components
- Within the `/studio` folder, remove all shopify-related schemas, desk structures, and actions
- Within the `/components/header.js` file, remove references to shopify `context` and `cart`
- `/contexts` folder _(used for accessing shopify data anywhere)_
- `/lib/shopify.js` file _(shopify client setup)_
- `SHOPIFY_*` env variables from `next.config.js`
- `shopify-buy` dependency from `package.json`

Error: Failed to communicate with the Sanity API

If you get this error in your CLI, you need to logout and log back in again. Simply do `sanity logout` and then `sanity login` to fix.

Access your "product_sync" metafields in Shopify without using a plugin

Simply navigate directly to: `https://[store_id].myshopify.com/admin/bulk?resource_name=Product&edit=metafields.sanity.product_sync`

_(making sure to replace [store_id] with your Shopify Store ID)_

How do I properly hand-off a Vercel project to the client?

While not as easy as Netlify, what I prefer to do is:
1. Have the client create their own [Vercel account](https://vercel.com/signup)
2. At the time of writing, Github connections can only be connected to one Vercel account at a time, so have the client [create a Github account](https://github.com/join) if they don't already have one, and transfer the project repo to them
3. Delete the dev project from your own Vercel account (this is so the client can utilize the project name and domain you were using during dev)
4. You or the client can now connect their newly transferred Github repo to their own Vercel account!

# 💯 Shoutouts
Huge ups to the following talented and rad folks who helped in countless ways. Thank you for all the support, code contributions, and for putting up with my _insane_ questions around headless shopify woes!
- 🔥 [@tuckercs](https://github.com/tuckercs)
- 🍝 [@iamkevingreen](https://github.com/iamkevingreen)
- 🧈 [@mikehwagz](https://github.com/mikehwagz)
- 😎 [@dictions](https://github.com/dictions)

# 🤝 License

### [MIT](LICENSE)
> [nickdimatteo.com](https://nickdimatteo.com) ·
> Github [@ndimatteo](https://github.com/ndimatteo) ·
> Instagram [@ndimatteo](https://instagram.com/ndimatteo)