mesh-research/cc-client

WordPress plugin for connecting to CommonsConnect server and the Knowledge Commons network.

Maintainers

Package info

github.com/MESH-Research/commons-connect-client

Type:wordpress-plugin

pkg:composer/mesh-research/cc-client

Transparency log

Statistics

Installs: 495

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 1

Security

Advisories: 0

Aikido package health analysis

dev-main 2026-08-13 14:32 UTC

Requires

Requires (Dev)

MIT 367f7ea3904d291c922167462e6eb24880d4e929

  • Mike Thicke <thickemi.woop@msu.edu>
  • Grant Eben <ebengran.woop@msu.edu>

Published on Packagist.org on 2026-08-13 14:44 UTC

This package is auto-updated.

Last update: 2026-08-13 14:44:09 UTC

README

This plugin provides WordPress blocks that interface with the Commons Connect API.

Getting Started

  1. Install Lando.
  2. Clone the CommonsConnect repository.
  3. In the cc-client directory, run lando start.
  4. Open the test site at https://commons-connect-client.lndo.site/.
  5. You can login to the WordPress admin at https://commons-connect-client.lndo.site/wp-admin/ with the username admin and password admin.

Interacting with the Search API

The Search block requires a running CommonsConnect search service:

  1. Change to the cc-search directory.
  2. Run lando start.
  3. In the cc-client directory, run lando wp cc search status to verify that the plugin can connect to the search service.
  4. In the cc-client directory, run lando wp cc search provision_test_docs to load test data into the search service.

Configuration

The Search API client timeouts and provisioning resilience behaviour are configurable via environment variables. See docs/search-api-timeouts.md for the available CC_SEARCH_TIMEOUT and CC_SEARCH_CONNECT_TIMEOUT settings and how the plugin avoids blocking the request when the Search API is unavailable.

Running Tests

Tests use the WordPress test functionality and PHPUnit. They require a running cc-search API. By default this is the local API running on http://commonsconnect-search.lndo.site.

Tests are located in the tests directory.

  1. Change to the cc-search directory.
  2. Run lando start.
  3. In the cc-client directory, run lando start.
  4. Run lando phpunit or lando phpunit-debug. To run a specific test run lando phpunit --filter <test-name>.

You can test against a different server configuration by overriding environment variables, as in dev-search-lando-override.lando.yml.

Pushing to Composer

Packagist is used to distribute the plugin, including for use on Knowledge Commons.

To push changes to Compose:

  1. Change to the root commons-connect directory.
  2. Run ./cc-client-subtree-push.sh