Skip to content

Latest commit

 

History

History
83 lines (61 loc) · 2.49 KB

README.md

File metadata and controls

83 lines (61 loc) · 2.49 KB
Raw

Overview

Repository for the Kindling WordPress theme by the Matchbox Design Group.

A block theme for WordPress that supports the Full Site Editing features.

Instructions

Requirements
  • Composer >= 2
  • Node.js = 16 (@wordpress/scripts requires Node.js 14.0.0 or later, and npm 6.14.4 or later. It is not compatible with older versions)
  • npm = 8
  • PHP >= 8.2
  • WordPress >= 6.1+
  • Yarn
Installation

Create a Local Environment

Clone Repository

From Terminal:

git clone [email protected]:matchboxdesigngroup/kindling.git

Or using Tower:

  1. Click the "Cloud" icon near the top left of the application.
  2. Choose your connected Github account and located the repo in the list.
  3. Click "Clone" and choose the directory (example: Users/[you]/Sites)
  4. The repo is now cloned to your computer.

Start local server

Using Docker - Colima + DDEV

Install Colima and DDEV if you have not already. Colima is an alternative to Docker Desktop.

  1. Start Colima if it's not already running

Once it is started Colima will always run until you stop it or restart your computer.

colima start
  1. Start DDEV

If another project is running make sure to run ddev stop first

 ddev start

Install WordPress, base plugins, and base default WP theme

Run this from the root of your project. Composer is configured to install WordPress core, some plugins, and the latest default WordPress theme.

  # @ project-name/
  $ composer install

Build/Compile the Kindling theme

Yarn for this purpose is similar to using npm or gulp. It grabs the package.json and installs packages and libraries.

In package.json there are several scripts. yarn build is generally intended for compiling a site to deploy to production and yarn dev is intended for local development, adding browsersync to watch for file changes and refresh your browser.

In terminal, change to the kindling theme directory and install the theme's dependencies and compile the CSS and JavaScript:

# @ wp-content/themes/kindling/
$ cd wp-content/themes/kindling/
$ yarn
$ yarn build
# or
$ yarn dev

Helpful Links