Skip to main content
View plugin on GitHub
See starters using this

Logo

Gatby Storefront – lightning fast PWA storefront for Shopify

GitHub package.json version GitHub Join the community on Spectrum

Please see our demo here. And if you like it please give us a star on GitHub ⭐ πŸ‘ πŸ˜€

About

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

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`,
});
module.exports = {
  plugins: [
    {
      resolve: '@gatsbystorefront/gatsby-theme-storefront-shopify',
      options: {
        shopName: process.env.GATSBY_SHOP_NAME,
        accessToken: process.env.GATSBY_SHOPIFY_ACCESS_TOKEN,
        basePath: '/',
      },
    },
  ],
};

Shopify content requirement

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

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 configuration is gatsbystorefront-config.js. Use it to:

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

Theme shadowing

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

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.

Santa Claus is coming to town

You better watch out
You better not cry
You better not pout
I'm telling you why
Cause Santa Claus is coming to town

Merry Christmas!


Docs
Tutorials
Plugins
Blog
Showcase