volto-eea-kitkat 🍫

Volto Add-ons bundle - A known good set of Volto addons to be used within all EEA projects and beyond

Included Volto Add-ons

1. @eeacms/volto-matomo
2. @eeacms/volto-sentry-rancher-config
3. @eeacms/volto-corsproxy
4. @eeacms/volto-depiction
5. @eeacms/volto-taxonomy
6. @eeacms/volto-object-widget
7. @eeacms/volto-widgets-view
8. @eeacms/volto-widget-toggle
9. @eeacms/volto-widget-temporal-coverage
10. @eeacms/volto-widget-geolocation
11. volto-slate:asDefault
12. @eeacms/volto-slate-metadata-mentions
13. @eeacms/volto-slate-footnote
14. @eeacms/volto-slate-zotero
15. @eeacms/volto-accordion-block
16. @eeacms/volto-block-toc
17. @eeacms/volto-block-divider
18. @eeacms/volto-listing-block
19. @eeacms/volto-metadata-block
20. @eeacms/volto-group-block
21. @eeacms/volto-columns-block
22. @eeacms/volto-tabs-block
23. @eeacms/volto-block-image-cards
24. @eeacms/volto-banner
25. @eeacms/volto-resize-helper
26. @eeacms/volto-block-style

Getting started

Creating a Volto Frontend for your new EEA project

1. Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone

2. Create and start Volto frontend

   npm install -g yo @plone/generator-volto
   yo @plone/volto new-project --addon @eeacms/volto-eea-kitkat
   cd new-project
   
   yarn
   yarn start
   

3. Go to http://localhost:3000

4. Happy hacking!

Add volto-eea-kitkat to your existing Volto Frontend

1. Make sure you have a Plone backend up-and-running at http://localhost:8080/Plone

2. Setup Volto frontend

   • Update package.json:

     "addons": [
        "@eeacms/volto-eea-kitkat"
     ],

   • Install new add-ons and restart Volto:

     yarn add -W @eeacms/volto-eea-kitkat
     yarn start
     

3. Go to http://localhost:3000

4. Happy hacking!

Try volto-eea-kitkat with Docker

1. Get the latest Docker images

   docker pull plone
   docker pull plone/volto
   

2. Start Plone backend

   docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
   

3. Start Volto frontend

   docker run -it --rm -p 3000:3000 --link plone -e ADDONS="@eeacms/volto-eea-kitkat" plone/volto
   

4. Go to http://localhost:3000

How to contribute

See DEVELOP.md.

Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

See LICENSE.md for details.

Funding

European Environment Agency (EU)