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

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

2. Wait for Volto started at 0.0.0.0:3000 meesage

3. Go to http://localhost:3000

4. Initialize git hooks

   yarn prepare

5. Happy hacking!

Before starting make sure your development environment is properly set. See Volto Developer Documentation

1. Make sure you have installed yo, @plone/generator-volto and mrs-developer

   npm install -g yo @plone/generator-volto mrs-developer
   

2. Create new volto app

   yo @plone/volto my-volto-project --addon @eeacms/volto-eea-design-system --skip-install
   cd my-volto-project
   

3. Add the following to mrs.developer.json:

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

4. Install

   make develop
   yarn
   

5. Start backend

   docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend
   

   ...wait for backend to setup and start - Ready to handle requests:

   ...you can also check http://localhost:8080/Plone

6. Start frontend

   yarn start
   

7. Go to http://localhost:3000

8. Happy hacking!

   cd src/addons/volto-eea-design-system/
   

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-eea-design-system to mrs.developer.json

Go to:

cd src/addons/volto-eea-design-system/

Start:

make
make start

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

Open Cypress Interface:

make cypress-open

Or run it:

make cypress-run