Quick Start ​

Know what you're doing and using a Unix-like system? Make sure you have all the prerequisites in place, then follow the base install instructions below, and create your plugin or theme.

If you need more detailed instructions or if you're using Windows, we have in-depth explanations on setting up your local environment, base WordPress installation and plugins/themes.

Base Install With Valet ​

Prerequisites ​

• macOs
• Valet
• PHP >= 8.1 (CLI and server)
• WP CLI
• Node.js 18.x lts/hydrogen
• cURL/Wget
• Composer ^2
• Bash
• Forme Codegen ^2.1

Steps ​

1. Set up a new MySQL database and make a note of the credentials

2. Change to your sites directory. For example:

cd ~/sites

3. Install and configure a new WordPress site directory (you'll be prompted for the database credentials):

forme base new hello-world

4. Change into this new site directory:

cd hello-world

5. Add the Valet driver if you haven't already:

cp utils/FormeServerValetDriver.php ~/.config/valet/Drivers/FormeServerValetDriver.php

6. Enable HTTPS:

valet secure

7. Visit the site e.g. https://hello-world.test in your browser and set up the admin user

Base Install With Docker ​

Prerequisites ​

• macOS/Linux
• Docker & docker-compose - you can get both of these by installing Docker Desktop
• PHP >= 8.1 (CLI)
• WP CLI
• Node.js 18.x lts/hydrogen
• cURL/Wget
• Composer ^2
• Bash
• Forme Codegen ^2.1

Steps ​

1. Change to your sites directory. For example:

cd ~/sites

2. Install and configure a new WordPress site directory:

forme base new hello-world

3. Change into this new site directory:

cd hello-world

4. Initialise Docker configuration:

forme ketch init

5. Launch Docker:

forme ketch up

7. Visit the site at http://localhost in your browser and set up the admin user

New Plugin / Theme ​

Prerequisites ​

• macOS/Linux
• PHP >= 8.1 (CLI)
• Forme Codegen ^2.1
• Node 18.x lts/hydrogen
• Git
• Composer ^2
• Bash
• Git Cliff (optional)

Steps ​

1. Change to your repos directory. For example:

cd ~/repos`

2. Create a new plugin or theme:

# plugin
forme new plugin hello-world

# theme
forme new theme hello-world

3. Change to the base WordPress installation directory:

cd ~/sites/hello-world

4. Symlink the repo directory into your base WordPress site installation or link it to your Docker:

# base installation e.g. valet
forme base link ~/repos/hello-world-plugin/

# docker
forme ketch link ~/repos/hello-world-theme/
# you might also need to restart container if it's running
forme ketch restart

5. Update PHP dependencies:

composer update