Installation / Setup

Node.js

Node version 20.12.2 is required.

PHP

Minimum required PHP version is 8.2

Chisel

New project

To create a new Chisel project run the following command in your project folder:

npx generator-chisel

npx generator-chisel

Follow the instructions shown in the terminal to complete the project setup. The generator will ask you several questions about your project configuration and create all necessary files.

Wait for the installation to finish and you should be able to open your project in the browser using the project-name.test url.

You can also install the project in docker using the command:

npx -y generator-chisel --devcontainer

npx -y generator-chisel --devcontainer

Existing Project

When joining the project with an existing chisel project in a repository follow theses steps to setup the project locally:

• Clone the repository
• Go to the project folder
• Run composer install
• Run npm install
• Run npm run wp-config

After creating the wp-config-local.php (with npm run wp-config) file make sure it contains the following:

define( 'WP_DEBUG', true ); 
define( 'WP_DEBUG_LOG', true ); 
define( 'WP_DEBUG_DISPLAY', false ); 
define( 'SCRIPT_DEBUG', true ); 
define( 'WP_ENVIRONMENT_TYPE', 'development' );

define( 'WP_DEBUG', true ); 
define( 'WP_DEBUG_LOG', true ); 
define( 'WP_DEBUG_DISPLAY', false ); 
define( 'SCRIPT_DEBUG', true ); 
define( 'WP_ENVIRONMENT_TYPE', 'development' );

• Run npm run build
• Run npm run dev to start local development. The url for local development is the same (project-name.test) with “fast refresh” mode enabled for CSS and JavaScript.