volto-plotlycharts

March 25, 2026 · View on GitHub

Develop

Make sure you have docker and docker compose installed and running on your machine:

git clone https://github.com/eea/volto-plotlycharts.git
cd volto-plotlycharts
git checkout -b bugfix-123456 develop
make
make start

Wait for Volto started at 0.0.0.0:3000 meesage
Go to http://localhost:3000
Initialize git hooks
```
yarn prepare
```
Happy hacking!

Or add @eeacms/volto-plotlycharts to your Volto project

Before starting make sure your development environment is properly set. See the official Plone documentation for creating a project with Cookieplone and installing an add-on in development mode in Volto 18 and 19.

For new Volto 18+ projects, use Cookieplone. It includes mrs-developer by default.

Create a new Volto project with Cookieplone

uvx cookieplone project
cd project-title

Add the following to mrs.developer.json:

{
    "volto-plotlycharts": {
        "output": "packages",
        "url": "https://github.com/eea/volto-plotlycharts.git",
        "package": "@eeacms/volto-plotlycharts",
        "branch": "develop",
        "path": "src"
    }
}

Add @eeacms/volto-plotlycharts to the addons key in your project volto.config.js
Install or refresh the project setup
```
make install
```
Start backend in one terminal
```
make backend-start
```
...wait for backend to setup and start, ending with Ready to handle requests

...you can also check http://localhost:8080/Plone
Start frontend in a second terminal
```
make frontend-start
```
Go to http://localhost:3000
Happy hacking!
```
cd packages/volto-plotlycharts
```

For legacy Volto 17 projects, keep using the yarn-based workflow from the Volto 17 documentation.

Cypress

To run cypress locally, first make sure you don't have any Volto/Plone running on ports 8080 and 3000.

You don't have to be in a clean-volto-project, you can be in any Volto Frontend project where you added volto-plotlycharts to mrs.developer.json

Go to:

cd packages/volto-plotlycharts/

Start:

make
make start

This will build and start with Docker a clean Plone backend and Volto Frontend with volto-plotlycharts block installed.

Open Cypress Interface:

make cypress-open

Or run it:

make cypress-run