Skip to content

Update readme to specify requiring the v2 REST API plugin from the Wo… #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kwight wants to merge 1 commit into from
Closed

Update readme to specify requiring the v2 REST API plugin from the Wo… #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ It means, that instead of loading new page every time you click a link, it uses
## Installation

### 1. Working WordPress installation
First, prepare a proper WordPress environment:
Ensure you have a proper WordPress development environment for working with the REST API. You will need:

* You will obviously need a working *WordPress* installation,
* You will also need *WP REST API*. It is a plugin (with plans to incorporate into the WordPress core) that creates REST API to be used by the theme. Plugin is currently **NOT** in plugins repository, you have to upload the files manually. Install and activate the [WP REST API](https://github.com/WP-API/WP-API/tree/master) plugin (make sure that you are using the `master` branch – the default is currently develop),
* Set your permlink structure to `/%year%/%monthnum%/%day%/%postname%/`.
* a working WordPress <a href="https://codex.wordpress.org/Installing_WordPress">installation</a>
* the <a href="https://wordpress.org/plugins/rest-api/">REST API version 2 plugin</a> from the WordPress.org plugin repository, installed and activated
* your <a href="https://codex.wordpress.org/Settings_Permalinks_Screen">permalink</a> structure set to `/%year%/%monthnum%/%day%/%postname%/`

### 2. Theme building (for _team_ building go to your local meetup)
Unlike other themes, this one uses a build process. JavaScript is an interpreted language, but we need to take certain steps (like transpiling React JSX syntax or SASS CSS syntax) to take the files from development phase to production. You will need the following tools:
Expand Down