WP Decoupled ⚡

This is a React theme boilerplate for WordPress, built with Next JS, Webpack, Babel, Node, Express.

Live demo site.

Live Demo

Demo 🎥

Getting Started 🏄

These instructions will get you a copy of the project up and running on your local machine for development purposes.

Installing 🔧

1. Clone this repo in git@github.com:rtCamp/wp-decoupled.git
2. cd wp-decoupled
3. npm install

Configure Backend( WordPress site ) 🔧

1. Add GraphQl support on WordPress

1. Clone and activate the following plugins, in your WordPress plugin directory:

   • wp-graphql Exposes graphql for WordPress
   • wp-graphql-jwt-authentication This plugin extends the wp-graphql plugin to provide authentication using JWT.
   • wp-graphiql Provides GraphiQL IDE (playground) to the WP-Admin
   • wp-graphql-woocommerce Adds Woocommerce functionality to a WPGraphQL schema( Tested upto v0.3.2 of wp-graphql-woocommerce)

2. 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 > WooCommerce products(CSV) : The WooCommerce default products csv file is available at wp-content/plugins/woocommerce/sample-data/sample_products.csv

2. For Authentication.

a. You can use any secret token of your choice, however it would be best if you generate one using WordPress Salt generator (https://api.wordpress.org/secret-key/1.1/salt/) to generate a Secret. And just pick up any one of the token and add it in place of 'your-secret-token' below:

Define a Secret in wp-config.php of your WordPress directory:

define( 'GRAPHQL_JWT_AUTH_SECRET_KEY', 'your-secret-token' );

b. Depending on your particular environment, you may have to research how to enable these headers, but in Apache, you can do the following in your .htaccess:

SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1

Configure Front end🔧

• Rename client-config-example.js to client-config.js and update your React Site URL

const config = {
	siteUrl: 'http://localhost:3000',
	graphqlUrl: 'http://wordpressSiteUrl/graphql',
	postCodeLocale: 'IN',
	authTokenName: 'wp-decoupled/AUTH_TOKEN' ,
};

• Rename wooConfig.example.js to wooConfig.example.js and update your React Site URL and WordPressSite URL ( Used access it in common js file. )

const wooConfig = {
	siteUrl: 'https://xyz.com',
	graphqlUrl: 'https://xxwordpresssitexx.com/graphql',
};

module.exports = wooConfig;

Commands 💻

• dev Runs the node server in development mode

Using PWA on mobile

• Open the site in Chrome on your mobile and then click on add to home screen.
• It will be downloaded and saved as a Progressive Web App on your mobile.
• Once added Look WP Decoupled app on your mobile.
• This PWA will work even when you are offline.

Branches Information: 🌱

1. master Main React WooCommerce theme
2. develop For testing
3. wp-docoupled-boilerplate Boilerplate to start a new React theme project with PWA implementation ( Work in Progress )

Author

• rtCamp

Contributor 👤

• Imran Sayed
• Muhammad Muhsin
• Divyaraj Masani
• Sayed Taqui

License 📃

This project is licensed under the MIT License - see the LICENSE.md file for details

Does this interest you?