https://github.com/imranhsayed/gatsby-wp-themes
Gatsby WordPress Theme
https://github.com/imranhsayed/gatsby-wp-themes
Last synced: about 2 months ago
JSON representation
Gatsby WordPress Theme
- Host: GitHub
- URL: https://github.com/imranhsayed/gatsby-wp-themes
- Owner: imranhsayed
- License: mit
- Created: 2021-01-18T15:10:42.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-01-18T15:21:19.000Z (over 4 years ago)
- Last Synced: 2024-12-28T09:04:09.986Z (6 months ago)
- Language: JavaScript
- Size: 260 MB
- Stars: 10
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 🎨 [Gatsby WP themes](https://codeytek.com/)
[](https://www.repostatus.org/#active)
- A Gatsby theme for WordPress, using Decoupled Architecture
- Front end in React
- Backend in WordPress.
- Can be used as a boilerplate.
This theme uses `gatsby-source-wordpress@v4 BETA`
*** 👨💻 Please star my repo to support my work 🙏 ***
## 🔥 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.
7. Google Analytics feature
8. Yoast SEO supported ( with og tags )
## 👨💻 Maintainer
| Name | Github Username |
|--------------------------------------------------------|-----------------|
| [Imran Sayed](mailto:[email protected]) | @imranhsayed |
## 🚀 Set Up
* Fork/clone the repo
* yarn install
### Gatsby Setup ( when using this repo as your project)
1. Server Side Environment 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`
2. 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.
```shell script
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](https://github.com/imranhsayed/gatsby-wp-themes/blob/master/wordpress/plugins/headless-cms.zip)
b. [wp-graphql](https://github.com/imranhsayed/gatsby-wp-themes/blob/master/wordpress/plugins/wp-graphql.zip) - tested on ( v1.0.0 )
c. [wp-gatsby](https://github.com/imranhsayed/gatsby-wp-themes/blob/master/wordpress/plugins/wp-gatsby.zip)
d. [Yoast-SEO](https://github.com/imranhsayed/gatsby-wp-themes/blob/master/wordpress/plugins/wordpress-seo.14.5.zip)
e. [wp-graphql-yoast-seo](https://github.com/imranhsayed/gatsby-wp-themes/blob/master/wordpress/plugins/wp-graphql-yoast-seo.zip)
2. - Set Header menu as `HCMS Header Menu`
- Set Footer menu as `HCMS Footer Menu`
3. You can also set text widgets in #HCMS Footer #1 and #HCMS Footer #2 under Appearance > Widgets in WordPress.
4. Create a Home Page ( if there isn't one already ) and make sure you have a home page ( Title should be Home and page slug should be 'home' )
5. If isn't already set your site title, description and logo from WordPress customizer.
7. For home page carousel please upload same size product category images of dimensions `1900x600`
## 🚀 Development
* Navigate into site’s directory.
```shell
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-wp-themes`
* `npm run storybook`
### :package: Adding/Removing a new package to site folder
`yarn workspace site add package-name`
`yarn workspace site remove package-name`
### :package: 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](https://prettier.io/). 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](https://www.gatsbyjs.org/docs/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](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail).
7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/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](https://www.gatsbyjs.org/docs/ssr-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.
### Deployment
#### [With vercel](https://gatsby-wp-themes.vercel.app/)
- Signup on [vercel.com](https://vercel.com/)
- Click on Import Project and then add the configurations.
- On [vercel](https://vercel.com/), 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: `/`
### Other popular themes
[https://www.npmjs.com/package/gatsby-woocommerce-theme](https://www.npmjs.com/package/gatsby-woocommerce-theme)
Follow its readme on npm.js
## Helpful Tools:
1. [Apollo Client Developer Tools Chrome Extension](https://chrome.google.com/webstore/detail/apollo-client-developer-t/jdkknkkbebbapilgoeccciglkfbmbnfm/related)