Skip to content

Latest commit

 

History

History
235 lines (161 loc) · 10.5 KB

README.md

File metadata and controls

235 lines (161 loc) · 10.5 KB
Raw

🎨 Gatsby WooCommerce themes - Electra

Project Status: Active. Stars Forks Contributors Download counter Follow

  • A Gatsby theme for WooCommerce, using Decoupled Architecture
  • Front end in React
  • Backend in WordPress.

Demo Site

This theme uses gatsby-source-wordpress@v4 BETA

*** 👨‍💻 Please star my repo to support my work 🙏 ***

gatsby woocommerce theme electra hero image

🔥 Features

  1. Uses React with Gatsby ( Blazing Fast )
  2. PWA ( Works Offline )
  3. Image Optimization ( blur effect )
  4. GraphQL ( with wp-graphql on WordPress )
  5. Custom Widgets, Menus, Social elements.
  6. WooCommerce store
  7. Google Analytics feature
  8. Yoast SEO supported ( with og tags )
  9. Product Search with pagination ( even works offline )
  10. Product pagination
  11. Archive pages.
  12. Authentication with JWT
  13. My Account page ( with Login and Registration )
  14. Create an account on checkout.
  15. Social share.
  16. Product Carousel.
  17. Add to wishlist( even works offline )

👨‍💻 Maintainer

Name Github Username
Imran Sayed @imranhsayed

Home Page demo

Search, Archive, Pagination.

Single product page with carousel, social share, image zoom

Add to Cart, Cart page, Checkout.

My account: Register

My account: Login

🚀 Set Up

  • Fork/clone the repo
  • yarn install

Gatsby Setup ( when using this repo as your project)

  1. Server Side Enviromnent Variables. Create a file called .env taking example from .env-example and add the following into site directory :
  • WORDPRESS_SITE_URL=https://example.com
  • GATSBY_SITE_URL=https://example.com
  • GOOGLE_TAGMANAGER_ID=xxx
  • FB_APP_ID=xxx
  1. Client Side Environment Variables. Create two more files called .env.development .env.production and into 'site' directory and add your WordPress site url liks so.
GATSBY_WORDPRESS_SITE_URL=https://example.com

Env variables from these file will be consumed by Apollo client on client side.

WordPress Setup

  1. On your WordPress site, download, Upload and activate all the plugins from wordpress/plugins folder of this repo, into your WordPress Site.

a. Headless CMS

b. woocommerce

c. wp-graphql - tested on ( v1.0.0 )

d. wp-graphql-woocommerce

e. wp-gatsby

f. Yoast-SEO

g. wp-graphql-yoast-seo

h. wp-graphql-jwt-authentication

    • Set Header menu as HCMS Header Menu

    • Set Footer menu as HCMS Footer Menu

  2. You can also set text widgets in #HCMS Footer #1 and #HCMS Footer #2 under Appearance > Widgets in WordPress.

  3. Create a Home Page ( if there isn't one already )and make sure you have a home page and Location rule is set to Home page.

  4. If isn't already set your site title, description and logo from WordPress customizer.

  5. Setup WooCommerce:

  • Make sure WooCommerce Plugin is active in WordPress and the payment modes have been set from its settings.
  • You can also import default wooCommerce products that come with wooCommerce Plugin for development ( if you don't have any products in your WordPress install ) WP Dashboard > Tools > Import > WooCommerce products(CSV): The WooCommerce default products csv file is available at wp-content/plugins/woocommerce/sample-data/sample_products.csv
  1. For home page carousel please upload same size product category images of dimensions 1900x600

🚀 Development

  • Navigate into site’s directory.
yarn install      # Run this for the first time.
npm run dev      # During development.
npm run build    # When ready for production.

** For development ** Your site is now running at http://localhost:8000!

_Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data.

📕 Storybook:

For Storybook:

  • cd package/gatsby-wooocommerce-theme
  • npm run storybook

📦 Adding/Removing a new package to site folder

yarn workspace site add package-name yarn workspace site remove package-name

📦 Adding/Removing a new package to gatsby-wooocommerce-theme folder

yarn workspace gatsby-wooocommerce-theme add package-name yarn workspace gatsby-wooocommerce-theme remove package-name

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── demos
├── packages
├── src
├── .gitignore
├── .site
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── package-lock.json
├── package.json
└── README.md

  1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

  2. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.

  3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

  4. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

  5. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

  6. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

  7. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

  8. gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.

  9. LICENSE: Gatsby is licensed under the MIT license.

  10. package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

  11. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

  12. README.md: A text file containing useful reference information about your project.

Useful Links

  1. Setting workspaces with yarn for theme development
  2. Installing a gatsby theme and setting it up.

Deployment

With vercel

  • Signup on vercel.com

  • Click on Import Project and then add the configurations.

  • On vercel, make sure you add these evn vars from settings of the project:

From CLI:

  • npm i -g vercel

  • Now in the project root run vercel

  • Add the following configurations

  • build command: npm run build
  • output directory: site/public
  • development command: npm run dev
  • root directory: /

Using as theme ( for existing gatsby project )

https://www.npmjs.com/package/gatsby-woocommerce-theme Follow its readme on npm.js

Helpful Tools:

  1. Apollo Client Developer Tools Chrome Extension