Skip to content
This repository was archived by the owner on Jan 13, 2026. It is now read-only.

Replace text based emojis with real emoji in README #74

Open
kirtangajjar wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Replace text based emojis with real emoji in README #74

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c183a1
Replace 'emoji text' with emoji in README
kirtangajjar Apr 7, 2022
7c38a44
Replace monitor with laptop
kirtangajjar Apr 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# WP Decoupled :zap:
# WP Decoupled ⚡️
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)

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

## Live demo site.
[Live Demo](https://wp-decoupled-git-master.rtcamp.vercel.app/)

## Demo :movie_camera:
## Demo 🎥

![](demo.gif)

## Getting Started :surfer:
## Getting Started 🏄️

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


### Installing :wrench:
### Installing 🔧

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

## Configure Backend( WordPress site ) :wrench:
## Configure Backend( WordPress site ) 🔧

### 1. Add GraphQl support on WordPress

Expand All @@ -36,7 +36,7 @@ These instructions will get you a copy of the project up and running on your loc
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 :lock:
### 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:
Expand All @@ -52,7 +52,7 @@ b. Depending on your particular environment, you may have to research how to ena
SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1
```

## Configure Front End :wrench:
## Configure Front End 🔧

* Rename `.env.example` to `.env` and update your details

Expand All @@ -64,7 +64,7 @@ WOO_SECRET=xxxxx
```


## Commands :computer:
## Commands 💻️

* `npm run dev` Runs the node server in development mode
* `npm run dev:inspect` Runs the dev server with **Inspector**
Expand All @@ -73,14 +73,14 @@ WOO_SECRET=xxxxx
* `npm run format` Runs the formatter
* `npm run build` Creates the **NEXT** build

## Using PWA on mobile :iphone:
## 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 :seedling:
## Branches Information 🌱

1. [master](https://github.com/rtCamp/wp-decoupled/tree/master) Main React WooCommerce theme
2. [develop](https://github.com/rtCamp/wp-decoupled/tree/develop) For testing
Expand All @@ -90,7 +90,7 @@ WOO_SECRET=xxxxx

* **[rtCamp](https://rtcamp.com)**

## Contributors :bust_in_silhouette:
## Contributors 👤

* **[Imran Sayed](https://github.com/imranhsayed)**
* **[Muhammad Muhsin](https://github.com/m-muhsin)**
Expand Down