WordPress / WordPress/wordpress-playground

Document system requirements for building locally

Open
#609 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

[Type] Developer Experience [Type] Documentation
Dominant language
JavaScript
Stars
2k
Forks
462
Avg merge
18h 44m
Merged PRs (30d)
33

Description

I cannot find documentation for the requirements for building the project locally.

Is Windows supported at all? After running npm install and trying to use
npm run dev or npm run build:website I am getting a lot of warnings.

The documentation in the readme.md file and on https://wordpress.github.io/wordpress-playground/architecture/host-your-own-playground#build-locally also lists different commands.

Examples:

'sleep' is not recognized as an internal or external command, operable program or batch file.

npm WARN config tmp This setting is no longer used.  npm stores temporary files in a special
npm WARN config location in the cache, and they are managed by
npm WARN config     [`cacache`](http://npm.im/cacache).

Warning: run-commands command "cp packages/playground/client/README.md dist/packages/playground/client" exited with non-zero status code

Warning: run-commands command "cp packages/php-wasm/web/README.md dist/packages/php-wasm/web" exited with non-zero status code

Error: Illegal characters in path.
    at pathArg (D:\wordpress-playground\node_modules\rimraf\dist\cjs\src\path-arg.js:45:33)
    at D:\wordpress-playground\node_modules\rimraf\dist\cjs\src\index.js:40:80
    at Array.map (<anonymous>)
    at D:\wordpress-playground\node_modules\rimraf\dist\cjs\src\index.js:40:42
    at main (D:\wordpress-playground\node_modules\rimraf\dist\cjs\src\bin.js:245:15)
    at Object.<anonymous> (D:\wordpress-playground\node_modules\rimraf\dist\cjs\src\bin.js:255:5)
    at Module._compile (node:internal/modules/cjs/loader:1256:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1310:10)
    at Module.load (node:internal/modules/cjs/loader:1119:32)
    at Module._load (node:internal/modules/cjs/loader:960:12) {
>  NX   Ran target build for project playground-website and 21 task(s) they depend on (35s)

    ×    5/14 failed
    √    9/14 succeeded [0 read from cache]

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the requirements and commands in README.md with the linked host-your-own-playground documentation. Start by checking npm install, npm run dev, and npm run build:website on the supported platforms, including the Windows errors shown here. Done means the documentation states system requirements, Windows support, and one consistent local-build procedure.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.