Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Here is a comprehensive directory map of the active services at the root of this

For most subprojects, you can spin up a local development instance with Node.js and Docker via `wp-env` under the `environments/` directory:

1. Ensure **Docker Desktop** is running.
1. Ensure a [Docker runtime](environments/README.md#docker-runtime) is running.
2. Navigate to [environments/](environments).
3. Run `npm install` to install dependencies.
4. Launch the environment of your choice:
Expand Down
21 changes: 20 additions & 1 deletion environments/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,28 @@ Local development environments for WordPress.org projects, powered by [`wp-env`]

## Prerequisites

- [Docker](https://www.docker.com/products/docker-desktop/) installed and running
- A Docker runtime, installed and running (see below)
- [Node.js](https://nodejs.org/) — the version in [.nvmrc](.nvmrc) (`nvm use`)

### Docker runtime

On macOS, use [Colima](https://github.com/abiosoft/colima). It's free and open source and needs no account.

```bash
brew install colima docker docker-compose
colima start --cpu 4 --memory 4
```

Homebrew installs Compose as a Docker CLI plugin outside the CLI's search path. On Apple Silicon, point the CLI at it by adding this property to `~/.docker/config.json`, keeping whatever else is already in the file:

```json
"cliPluginsExtraDirs": [ "/opt/homebrew/lib/docker/cli-plugins" ]
```

Colima remembers the CPU and memory settings, so later starts are just `colima start`. To start it at login instead, run `brew services start colima`.

On Windows, consider using [Rancher Desktop](https://rancherdesktop.io/) with its dockerd (moby) engine, or [Docker Desktop](https://www.docker.com/products/docker-desktop/). On Linux, use [Docker Engine](https://docs.docker.com/engine/install/).

## Setup

From the `environments/` directory:
Expand Down
Loading