README.md

Volto Add-on (@plone-collective/volto-relateditems-block)

A new add-on for Volto

This block was developed during World Plone Day 2024.

Features

Blocks

• Related Items block

Installation

To install your project, you must choose the method appropriate to your version of Volto.

Volto 17 and earlier

Create a new Volto project (you can skip this step if you already have one):

npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --addon @plone-collective/volto-relateditems-block
cd my-volto-project

Add @plone-collective/volto-relateditems-block to your package.json:

"addons": [
    "@plone-collective/volto-relateditems-block"
],

"dependencies": {
    "@plone-collective/volto-relateditems-block": "*"
}

Download and install the new add-on by running:

yarn install

Start volto with:

yarn start

Volto 18 and later

Add @plone-collective/volto-relateditems-block to your package.json:

"dependencies": {
    "@plone-collective/volto-relateditems-block": "*"
}

Add @plone-collective/volto-relateditems-block to your volto.config.js:

const addons = ['@plone-collective/volto-relateditems-block'];

If this package provides a Volto theme, and you want to activate it, then add the following to your volto.config.js:

const theme = '@plone-collective/volto-relateditems-block';

Test installation

Visit http://localhost:3000/ in a browser, login, and check the awesome new features.

Development

The development of this add-on is done in isolation using a new approach using pnpm workspaces and latest mrs-developer and other Volto core improvements. For this reason, it only works with pnpm and Volto 18 (currently in alpha).

Pre-requisites

• Node.js
• Make
• Docker

Make convenience commands

Run make help to list the available commands.

help                             Show this help
install                          Installs the add-on in a development environment
start                            Starts Volto, allowing reloading of the add-on during development
build                            Build a production bundle for distribution of the project with the add-on
i18n                             Sync i18n
ci-i18n                          Check if i18n is not synced
format                           Format codebase
lint                             Lint, or catch and remove problems, in code base
release                          Release the add-on on npmjs.org
release-dry-run                  Dry-run the release of the add-on on npmjs.org
test                             Run unit tests
ci-test                          Run unit tests in CI
backend-docker-start             Starts a Docker-based backend for development
storybook-start                  Start Storybook server on port 6006
storybook-build                  Build Storybook
acceptance-frontend-dev-start    Start acceptance frontend in development mode
acceptance-frontend-prod-start   Start acceptance frontend in production mode
acceptance-backend-start         Start backend acceptance server
ci-acceptance-backend-start      Start backend acceptance server in headless mode for CI
acceptance-test                  Start Cypress in interactive mode
ci-acceptance-test               Run cypress tests in headless mode for CI

Development environment set up

Install package requirements.

make install

Start developing

Start the backend.

make start-backend-docker

In a separate terminal session, start the frontend.

pnpm start

Lint code

Run ESlint, Prettier, and Stylelint in analyze mode.

make lint

Format code

Run ESlint, Prettier, and Stylelint in fix mode.

make format

i18n

Extract the i18n messages to locales.

make i18n

Unit tests

Run unit tests.

make test

Run Cypress tests

Run each of these steps in separate terminal sessions.

In the first session, start the frontend in development mode.

make start-test-acceptance-frontend-dev

In the second session, start the backend acceptance server.

make start-test-acceptance-server

In the third session, start the Cypress interactive test runner.

make test-acceptance

License

The project is licensed under the MIT license.