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

Try volto-banner with Docker

  git clone https://github.com/eea/volto-banner.git
  cd volto-banner
  make
  make start

Go to http://localhost:3000

Add volto-banner to your Volto project

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

   docker compose up backend

2. Start Volto frontend

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

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

• If not, create one:

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

1. Install new add-ons and restart Volto:

   yarn
   yarn start

2. Go to http://localhost:3000

3. Happy editing!

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)