README.md

Gatby Storefront – lightning fast PWA storefront for Shopify

Gatby Storefront is a headless eCommerce PWA storefront for Shopify. Powered by GatsbyJS it brings eCommerce to the edge for lightning fast webstore performance.

Please see our demo here. And if you like it please give us a star on GitHub ⭐ 👍 😀

• Demo
• Setup guide
  • Install CLI
  • Create store site
  • Install Gatsby Storefront
  • Create .env file
  • Enable theme
  • Shopify content requirement
  • Starter
• Configuration
  • Configuration file
  • Theme shadowing
  • Development
  • Build
  • Serve
  • Publish

Demo

Exceptional Lighthouse audit results:

Please, see the demo here: https://demo.gatsbystorefront.com.

Setup guide

Install CLI

Install the Gatsby CLI:

npm install -g gatsby-cli

Create store site

Create new gatsby site for your web store:

gatsby new store

Install Gatsby Storefront

Install Gatsby Storefront NPM package:

npm install @gatsbystorefront/gatsby-theme-storefront-shopify

Create .env file

Create .env file in your store's root directory with your Shopify storename (storename.myshopify.com) and access token (your token must have full permissions on Storefront API).

GATSBY_SHOP_NAME=your_shopify_store_name
GATSBY_SHOPIFY_ACCESS_TOKEN=your_shopify_access_token

Enable theme

Enable gatsbystorefront/gatsby-theme-storefront-shopify plugin in your gatsby-config.js:

require("dotenv").config({ path: `.env` })
const flattenMenu = require("@gatsbystorefront/gatsby-theme-storefront-shopify/src/utils/flattenMenu")

module.exports = {
  plugins: [
    {
      resolve: '@gatsbystorefront/gatsby-theme-storefront-shopify',
      options: {
        shopName: process.env.GATSBY_SHOP_NAME,
        accessToken: process.env.GATSBY_SHOPIFY_ACCESS_TOKEN,
        basePath: '/',
        shopifyLite: false, // default 'false'
        enableWebp: true, // default 'true'
      },
    },
  ],
  siteMetadata: {
    siteUrl: 'https://demo.gatsbystorefront.com',
    gatsbyStorefrontConfig: {
      // Your Gatsby Storefront configuration
      // Copy exmaple from the starter:
      // https://github.com/GatsbyStorefront/gatsby-starter-storefront-shopify/blob/master/gatsby-config.js

    }
};

Shopify content requirement

Please make sure that your Shopify web store has at least one Collection, one Product (associated with Collection), Blog post, Page and store Policies added before runing your Gatsby Storefront, as it is neccesary for correct API exposure.

A setup for Shopify Lite plan

If you are using Shopify Lite plan. Please set shopifyLite property to true in @gatsbystorefront/gatsby-theme-storefront-shopify plugin options in gatsby-config.js. This will disable generation of pages for Blog and Pages as they are not avalible in "Lite" plan.

Starter

You can also use the starter package for fatster setup process.

gatsby new store gatsbystorefront/gatsby-starter-storefront-shopify

This downloads the files and initializes the site by running npm install.

Configuration

Configuration file

Main theme configuration options are located in gatsbyStorefrontConfig object in gatsby-config.js file. Use it to:

• Configure main store parameters.
• Set up main menu and footer links.

Theme shadowing

• Use shadowing for making necessary changes in @gatsbystorefront/gatsby-theme-storefront-shopify theme.
• Use shadowing of @gatsbystorefront/gatsby-theme-storefront-shopify/src/gatsby-plugin-theme-ui/index.js to change theme colors in accordance with theme-ui specification.

For code example please see our shadowing exmaple repo.

Note: In order to work in shadowed components GrapshQL queries have to be renamed.

Development

gatsby develop

Will start a hot-reloading development environment accessible by default at localhost:8000.

Build

gatsby build

Will perform an optimized production build for your site, generating static HTML and per-route JavaScript code bundles.

Serve

gatsby serve

Starts a local HTML server for testing your built site. Remember to build your site using gatsby build before using this command.

Publish

After making a build, upload public/ directory to your web host. See additional instructions here.

Thank you!

Thank you! And we would love to hear your feedback [😍😜😮😐😤].

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Pavel 💻 🎨 📖 💡 🤔 📆 👀

mimibar 🐛 💻

This project follows the all-contributors specification. Contributions of any kind welcome!