https://github.com/boxuk/wp-ai-content-generation
https://github.com/boxuk/wp-ai-content-generation
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/boxuk/wp-ai-content-generation
- Owner: boxuk
- Created: 2025-05-23T12:34:00.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-11T12:32:48.000Z (about 1 year ago)
- Last Synced: 2025-07-13T16:09:05.812Z (about 1 year ago)
- Language: PHP
- Size: 627 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# WordPress AI Content Generation
This proof of concept aims to provide a method for users to have rich, block-based content generation from an AI by providing the relevant structure and framework to provide the data needed for both the AI to select a component to use, and the correct format for WP to parse the content and generate the blocks in the editor as needed.
## Getting Started
As a pre-requisite, you'll require **node** and **docker** to work on this project. The project is powered by `@wordpress/env` ([docs](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/)) and `@wordpress/scripts` ([docs](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-scripts/)) for compiling and providing a working environment.
```bash
npm install # Install Deps
npm run env start # Start the environment
npm run composer install # Install Composer deps
npm run start # Start the build/watcher
```
This will get you a local WP environemnt and start the build watcher. To stop the environment run `npm run env stop`, or check out the docs for more things you can do to manage the build process or your environment. There's _lots_ of options in the docs, so worth checking out if you're unsure how to access things like logs or to connect xdebug.
You'll also need to setup your local `.env` file, baed on the `.env.dist` file. This file should include an OpenAI API key. This should not be committed to the repository.
## Working with the Content Generator
The content generation uses Action Scheduler to handle making multiple AI requests asynchronously since each request is likely to timeout. Action Scheduler doesn't always work well on local setups due to the lack of traffic. Because of this, you can run action scheduler workers manually by calling
```sh
npm run wp action-scheduler run
```
## Running Commands
You can use your host `npm` to manage node packages. All other commands can be run inside the docker container by following [this documentation](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/#using-composer-phpunit-and-wp-cli-tools). As a convenience, you can run `composer` by running `npm run composer`, followed by any arguments. For named arguments, you'll need to use double-double-dashes to pass the named argument to the running comand so it's not interpreted by NPM or wp-env. ie:
```bash
npm run composer install -- --no-dev
```
Typically I'd suggest running any PHP related commands as composer scripts to resolve ambiguity. You can also setup node package scripts to reference the composer scripts, allowing you to run single commands easily. Take a look at `npm run lint:php` for example.