https://github.com/wordpress/wporg-developer
WordPress.org Developer theme
https://github.com/wordpress/wporg-developer
wporg
Last synced: 6 months ago
JSON representation
WordPress.org Developer theme
- Host: GitHub
- URL: https://github.com/wordpress/wporg-developer
- Owner: WordPress
- Created: 2022-05-19T02:03:37.000Z (about 4 years ago)
- Default Branch: trunk
- Last Pushed: 2025-02-20T08:02:44.000Z (over 1 year ago)
- Last Synced: 2025-04-06T02:07:50.415Z (about 1 year ago)
- Topics: wporg
- Language: PHP
- Homepage: https://developer.wordpress.org/
- Size: 5.08 MB
- Stars: 61
- Watchers: 16
- Forks: 30
- Open Issues: 72
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Developer.WordPress.org Theme
## Development
### Prerequisites
* Docker
* Node/npm
* Yarn
* Composer
### Setup
1. Set up repo dependencies.
```bash
yarn setup:tools
```
1. Build the assets. If there's anything that needs setting up.
```bash
yarn build
```
1. Start the local environment.
```bash
yarn wp-env start
```
1. Run the setup script.
```bash
yarn setup
```
1. Visit site at [localhost:8888](http://localhost:8888).
1. Log in with username `admin` and password `password`.
### Environment management
These must be run in the project's root folder, _not_ in theme/plugin subfolders.
* Stop the environment.
```bash
yarn wp-env stop
```
* Restart the environment.
```bash
yarn wp-env start
```
* Open a shell inside the docker container.
```bash
yarn wp-env run wordpress bash
```
* Run wp-cli commands. Keep the wp-cli command in quotes so that the flags are passed correctly.
```bash
yarn wp-env run cli "post list --post_status=publish"
```
* Update composer dependencies and sync any `repo-tools` changes.
```bash
yarn update:tools
```
* Watch for SCSS changes and rebuild the CSS as needed.
```bash
yarn start:theme
```
* Parse the code reference again. This is run as part of the project setup.
```bash
yarn parse
```
### Asset management
* Build assets once: `yarn build:theme`
* Watch assets and build on changes: `yarn start:theme`