WritePoetry WordPress Plugin

Welcome to the WritePoetry Repo on GitHub. Here you can find the source code used in the development of the WritePoetry plugin. You can browse the source, look at open issues, contribute code, and keep tracking of ongoing development.

Getting Started

To get up and running within the WritePoetry Repo, you will need to make sure that you have installed all of the prerequisites.

Prerequisites

• volta: While you can always install Node through other means, we recommend using volta to ensure you're aligned with the version used by our development teams. The repository contains a package.json file with required Node.js version specified in the engines field which helps ensure you are using the correct version of Node.
• Docker: wp-env is powered by Docker. There are instructions available for installing Docker on Windows (we recommend the WSL2 backend), macOS, and Linux.

NOTE: If Docker Desktop application slows down your local machine, you could consider using Local WP as an alternative.

The steps are:

• Install Local WP.
• Create a new website project in Local.
• Clone the WritePoetry Plugin from GitHub directly into the wp-content/plugins/ folder of the newly created project.
• Click on 'Start site' button and you are ready to go!

Once you've installed all of the prerequisites, you can run the following commands to get everything working.

# Clone the project repository including nested submodules
git clone --recurse-submodules https://github.com/WritePoetry/writepoetry-plugin
# Install the Node.js packages and dependencies
npm install
# Start the local environment
npm run env:start

If no vendor folder is present, you have to install composer dependencies using this command:

npm run composer install -- --no-dev --no-interaction --prefer-dist --optimize-autoloader

Finally, navigate to http://localhost:8888 in your web browser to see WordPress running with the local WritePietry plugin and Twenty Twenty-Child theme running and activated. Default login credentials are username: admin password: password.

Debugging

Read the official wp-env documentation to enable Xdebug when working on this project.

Xdebug VS Code support

Read the section of the guide that explain how to enable Xdebug in VS Code

Remember that the pathMappings inside .vscode/launch.json file should be as the following

{
    "pathMappings": {
        "/var/www/html/wp-content/plugins/writepoetry-plugin": "${workspaceFolder}/",
        "/var/www/html/wp-content/themes/blankspace-theme": "${workspaceFolder}/themes/blankspace/",
        "/var/www/html/wp-content/mu-plugins": "${workspaceFolder}/mu-plugins/"
    }
}

Contributing to WritePoetry

If you have a patch or have stumbled upon an issue with WritePoetry plugin, you can contribute this back to the code. Please read this plugin contributor guidelines for more information on how you can do this.