Development Environment

Setting Up the Environment

Local Development Tools

    1. Local by Flywheel: A user-friendly local WordPress development tool.
    2. Docker with wp-env: A containerized WordPress environment for advanced users.
    3. Installing Dependencies

      Run the following commands in the plugin directory:

      `bash

      Install PHP dependencies

      composer install

      Install JavaScript dependencies

      npm install
      `

      Building Assets

      Compile the plugin’s assets:

      `bash
      npm run build
      `

      Watching for Changes

      For development, use the following command to enable hot reloading:

      `bash
      npm run dev
      `

      Code Quality Tools

      PHP Tools

    4. PHPCS: Enforces WordPress Coding Standards.
    5. PHPStan: Performs static analysis to catch errors.
    6. JavaScript Tools

    7. ESLint: Lints JavaScript files for errors.
    8. Prettier: Formats code for consistency.

File Structure Overview

`
complyflow/
├── assets/ # Frontend and backend assets
├── includes/ # Core plugin functionality
├── templates/ # Frontend templates
├── languages/ # Translation files
├── complyflow.php # Main plugin file
└── composer.json # PHP dependencies
`

Share this article

Was this article helpful?

Help us improve our documentation

Still need help?

Our support team is ready to assist you with personalized guidance for your workspace.

Submit a support ticket