Comet Components is an active work in progress. These docs and the code currently available via GitHub and Packagist should be considered an incomplete alpha release.

WordPress integration development (ClassicPress / Classic Editor + ACF Pro)

Info

This section of the docs covers developing the Comet Components suite of WordPress plugins (Comet Components for ACF Flexible Modules) themselves.

For guidance on implementing Comet Components in your own plugins and themes, see the Custom Plugins and Themes page.

Prerequisites

  • Composer installed on your machine
  • Local WordPress or ClassicPress installation to use for testing
  • ACF Pro installed and activated in your local WordPress/ClassicPress installation
  • If using WordPress, the Classic Editor plugin installed and activated in your local WordPress installation
  • Local dev setup for the Comet Components project as a whole
  • The Comet Components monorepo cloned to your local machine and open in your IDE
  • Sufficient permissions to create symlinks.

Warning

Make sure any PhpStorm file watchers you have for your WordPress site are scoped to your own plugin and theme. If you leave them scoped to the entire project, they'll try to compile the various Comet packages' assets, which you don't need it to do and won't work because of file path differences.

Warning

This documentation is incomplete, sorry!