Volto Add-ons bundle - A known good set of Volto addons to be used within all EEA projects and beyond.
The eea.kitkat Plone add-on is the backend support for volto-eea-kitkat.
This version adds support for
Volto 17
and it is meant to be used withVolto 17+
. It may work withVolto 16
but it is not fully backward compatible (especially in Teaser block, anchors, listing), thus upgradingvolto-eea-kitkat
to version25+
implies also upgrading toVolto 17+
.
This versions comes with
@eeacms/volto-tabs-block 17.x
. See this package upgrade guide
This version requires:
@plone/volto >= 16.0.0.alpha.45
(Sentry removed from Volto Core).
This version requires:
@plone/volto >= 16.0.0.alpha.15
(volto-slate
part of Volto Core).
Volto EEA KitKat provides a set of generic Volto Add-ons and a Known Good Set
of these add-ons versions to be used within your Volto projects without having to worry about which add-on version works best with another add-on.
While in other systems when you pin a package version to a specific number you will get that package version, in Javascript world is not that simple.
For this, Volto EEA Kitkat is using selective dependency resolutions. While this work as expected in most of the cases, you may still have some surprises.
Make sure your Volto project yarn.lock
is not polluted. You can always reset your Volto project yarn.lock
with:
$ npm install -g @plone/generator-volto
$ cd my-volto-project
$ yo @plone/volto --skip-install --no-interactive /tmp/new-volto-project
$ cp /tmp/new-volto-project/yarn.lock .
$ yarn
Add-on resolutions
don't work with workspaces
(development mode), thus you'll need to define resolutions
within Volto project. To tackle this issue, this Docker image automatically extracts resolutions
from add-on and add them also to the Volto project before running tests.
git clone https://github.com/eea/volto-eea-kitkat.git
cd volto-eea-kitkat
make
make start
Go to http://localhost:3000
Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone
docker compose up backend
Start Volto frontend
If you already have a volto project, just update package.json
:
"addons": [
"@eeacms/volto-eea-kitkat"
],
"dependencies": {
"@eeacms/volto-eea-kitkat": "*"
}
If not, create one:
npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --canary --addon @eeacms/volto-eea-kitkat
cd my-volto-project
Install new add-ons and restart Volto:
yarn
yarn start
Go to http://localhost:3000
Happy editing!
See RELEASE.md.
See DEVELOP.md.
The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.
See LICENSE.md for details.