README.md

volto-bise

Volto add-on

Features

An addon for Volto specific to the BISE website.

Notes to developers

4th of November, 2020

We are depending directly on plotly.js 1.57.0 instead of the latest 1.57.1 because it has a regression that is specific to our use case.

When displaying the MAES Viewer block (more precisely the MAES Viewer View component) it crashes the web application with error:

Cannot convert undefined or null to object

This error seems to be coming from the InnerLoadable inside @loadable/component package but this bug is not reproducible in a simple create-react-app test project.

More precisely, the error is thrown in the InnerLoadable component created by Context.Consumer which is used in Unknown created by ForwardRef which is used in ForwardRef created at MaesViewerView.jsx:93. This line contains the tag for the component passed through @loadable/component: <LoadablePlot ....

More info can be found in:

1. this closed GitHub issue;
2. our PR related to this;
3. the changelog for v1.57.1;
   1. in the changelog there seems to be only one relevant change.

Getting started

Try volto-bise 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-bise" plone/volto
   

4. Go to http://localhost:3000

Add volto-bise to your Volto project

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

2. Start Volto frontend

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

  "addons": [
      "@eeacms/volto-bise"
  ],
  
  "dependencies": {
      "@eeacms/volto-bise": "^1.0.0"
  }

• If not, create one:

  npm install -g yo @plone/generator-volto
  yo @plone/volto my-volto-project --addon @eeacms/volto-bise
  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)