@eeacms/volto-banner

volto-banner

Volto add-on

Features

A customizable banner to highlight to the user that the website is in demo, dev or staging state.

It is configurable through /controlpanel/banner.

Upgrades

Upgrade to 2.x.x

• Version 2.x.x requires eea.banner Plone add-on to be installed on backend.

Getting started

Start Plone backend with Docker

1. Get the latest Docker images

   docker pull plone
   docker pull plone/volto
   

2. Start Plone backend

   docker run -it --rm -p 8080:8080 -e SITE=Plone -e ADDONS="eea.banner" -e PROFILES="profile-eea.banner:default" plone
   

3. Go to http://localhost:3000

Add volto-banner to your Volto project

1. Start Volto frontend

• If you already have a volto project, just update package.json:

  "addons": [
      "@eeacms/volto-banner"
  ],
  
  "dependencies": {
      "@eeacms/volto-banner": "^2.0.0"
  }
  

• If not, create one:

  npm install -g yo @plone/generator-volto
  yo @plone/volto my-volto-project --addon @eeacms/volto-banner
  cd my-volto-project
  

1. Install new add-ons and start Volto:

   yarn
   yarn start
   

2. Go to http://localhost:3000

3. Login admin:admin

4. Go to Site Setup > Banner settings and configure your banner

Release

See RELEASE.md.

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)

Changelog

3.1.1 - 12 June 2023

:house: Internal changes

• chore: [JENKINS] Deprecate circularity website [valentinab25 - 33c33b9]

:hammer_and_wrench: Others

• test: jest should look for addons in node_modules Refs #253277 [valentinab25 - 189e3d6]
• test: Fix test config, coverage Refs #253277 [valentinab25 - 5ef16e6]
• Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - 8124767]