Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 2.07 KB

INSTALLATION.md

File metadata and controls

61 lines (38 loc) · 2.07 KB
Raw

Installation

This installation works on both OSX and Linux. Windows is not supported yet, if you want to help with that let us know: wordpress-clients#39

Prerequisites

  • Git
  • NodeJS (>= 4)
  • NPM (>= 3)
  • Yarn

If you are running linux you might need to install all of the following dependencies: https://github.com/shprink/wphc-dockerbox/blob/master/Dockerfile#L13-L14

Clone repository

$ git clone https://github.com/shprink/wordpress-hybrid-client.git

# Open the project folder
$ cd wordpress-hybrid-client

# List all versions
$ git tag
v2.0.0
etc.

# checkout the latest version available
$ git checkout <the-latest-version>

Install dependencies

The installation will not install anything globally to avoid potential version conflicts.

# install dependencies
yarn

This could takes several minutes.

During the installation you might have the following error on OSX:

  • ld: library not found for -lgcc_s.10.5: Installing XCode 7 will solve the problem

Config files

Your personal config files live now in the config folder. You can modify all of them except config.default.cson which contains the default config that can be overwritten using config/config.cson

Installing the Web service

Since WordPress 4.7, there is no need to install anything. The WP-API is not part of the WP core!

If you do not have your WP setup yet, no problem http://dev.julienrenaux.fr/wp-json is set by default for you to try features. Change it when you are ready.

Installing better image plugin (optional)

If you want to reduce the number of HTTP requests made by WPHC to fetch feature images (one per image) you can install this plugin: https://wordpress.org/plugins/better-rest-api-featured-images/

Now you can either configure your app or start running the app on the browser with default parameters.