https://github.com/ryelle/wporg-plugin-directory

The WordPress Plugin Directory
https://github.com/ryelle/wporg-plugin-directory

Last synced: 17 days ago
JSON representation

The WordPress Plugin Directory

• Host: GitHub
• URL: https://github.com/ryelle/wporg-plugin-directory
• Owner: ryelle
• Created: 2024-08-05T20:06:01.000Z (5 months ago)
• Default Branch: trunk
• Last Pushed: 2024-08-05T20:09:15.000Z (5 months ago)
• Last Synced: 2024-11-30T21:44:27.355Z (25 days ago)
• Language: PHP
• Size: 3.1 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Plugin Directory

The codebase and development environment for the WordPress.org Plugin Directory.

This is as-yet incomplete, a starting point.

## Development

### Prerequisites

* Docker

* Node/npm

* Composer

### Setup

1. Set up repo dependencies.

	```bash

	npm run setup:tools

	```

1. Start the local environment.

	```bash

	npm run wp-env start

	```

1. Run the setup script.

	```bash

	npm run setup:wp

	```

1. (optional) There may be times when you want to make changes to the Parent theme and test them with the Main them. To do that:

	1. Clone the Parent repo and follow the setup instructions in its `readme.md` file.

	1. Create a `.wp-env.override.json` file in this repo

	1. Copy the `themes` section from `.wp-env.json` and paste it into the override file. You must copy the entire section for it to work, because it won't be merged with `.wp-env.json`.

	1. Update the path to the Parent theme to the Parent theme folder inside the Parent repository you cloned above.

	```json

	{

		"themes": [

			"./source/wp-content/themes/wporg-plugins-2024"

			"../wporg-parent-2021/source/wp-content/themes/wporg-parent-2021"

		]

	}

	```

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

	npm run wp-env stop

	```

* Restart the environment.

	```bash

	npm run wp-env start

	```

* Reset WordPress to a clean install, and reconfigure. This will nuke all local WordPress content!

	```bash

	npm run wp-env clean all

	npm run setup:wp

	```

* SSH into docker container.

	```bash

	npm run wp-env run wordpress bash

	```

* Run wp-cli commands. Keep the wp-cli command in quotes so that the flags are passed correctly.

	```bash

	npm run wp-env run cli wp post list --post_status=publish

	```

* Update composer dependencies and sync any `repo-tools` changes.

	```bash

	npm run update:tools

	```