This repo contains a WordPress integration of the Projects and Software overview for the Research Software Directory, using the RSD API.

To display the overview on your WordPress site, add the shortcode to any post or page. For example, the Software section for the Netherlands eScience Center organisation:

[research_software_directory section="software" organisation-id="35c17f17-6b5f-4385-aa8b-6b1d33a10157"]

To show the Projects section instead:

[research_software_directory section="projects" organisation-id="35c17f17-6b5f-4385-aa8b-6b1d33a10157"]

To limit the initial number of items shown at page load to nine:

[research_software_directory section="software" limit="9" organisation-id="35c17f17-6b5f-4385-aa8b-6b1d33a10157"]

Note: only one [research_software_directory] shortcode per page is supported; any further occurrences render a notice instead of a second overview. The shortcode works in post and page content, and also in widgets and template files (where the plugin styles load in the footer).

After activating the plugin, go to Settings → Research Software Directory in the WordPress admin to configure which filters are shown for each section and to set a default image for items without one.

• Node.js >= 22 (see .nvmrc) and pnpm for building the front end assets
• Composer for the PHP coding standards tooling
• Docker for the quick-start test environment below

For a quick test environment, this repo uses wp-env, the standard WordPress tool for spinning up a Dockerized WordPress site with the current plugin already mounted and activated:

# Install dependencies and build the (unminified) front end assets
$ pnpm install
$ pnpm run dev:build

# Start the environment
$ pnpm run env:start

This starts a WordPress site at http://localhost:8888 (log in at /wp-admin with admin / password) with the plugin active and a page containing the [research_software_directory] shortcode already published, so you can try the plugin out immediately.

$ pnpm run env:stop      # stop the environment
$ pnpm run env:destroy   # tear it down completely
$ pnpm run env:cli       # run any wp-cli command, e.g. `pnpm run env:cli plugin list`

To use the plugin in an existing WordPress installation instead, move the plugin folder to the plugins folder of your installation, which is usually something like <wordpress_folder>/wp-content/plugins/.

The project uses Vite to build the plugin front end assets (CSS and JS) into the dist/ folder. Production builds are minified (.min suffix) according to the project's Browserslist configuration, using Autoprefixer and Babel for cross-browser compatible code.

Which files WordPress loads depends on the environment: minified .min bundles are used when wp_get_environment_type() is production or staging, and unminified bundles otherwise. So make sure to run the build that matches your environment:

# First install the required Node.js dependencies
$ pnpm install

# Development build in watch mode (unminified)
$ pnpm run dev

# Production build (minified, with sourcemaps)
$ pnpm run build

This project uses EditorConfig to maintain a consistent coding style. Please make sure your editor applies this configuration to any of your code changes for this repo.

JavaScript is linted with ESLint, using the WordPress ESLint plugin:

# Check all JS files in src/
$ pnpm run lint

# Automatically fix violations where possible
$ pnpm run lint:fix

PHP follows the WordPress Coding Standards, checked with PHP_CodeSniffer using the bundled .phpcs.xml configuration. Please run it before committing any PHP changes:

# Install PHP_CodeSniffer and related packages
$ composer install

# Run PHPCS to check all PHP files in the project
$ composer run lint

# Or use PHP Code Beautifier and Fixer to automatically correct coding standard violations
$ composer run format

To create a smaller, production-ready ZIP file of all the plugin files without any development related files, use the project export script:

# Export ZIP file to the export/ folder
$ pnpm run export

The folder extracted from the ZIP file, which contains the plugin files required for production, can then be used to deploy to a production server.

This plugin is licensed under the Apache License 2.0.