Skip to content

DEVELOP.md

Latest commit

 

History

History
110 lines (71 loc) · 2.52 KB

DEVELOP.md

File metadata and controls

110 lines (71 loc) · 2.52 KB

volto-columns-block

Develop

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

    git clone https://github.com/eea/volto-columns-block.git
cd volto-columns-block
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!

Or add @eeacms/volto-columns-block to your Volto project

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

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

  1. Create a new Volto project with Cookieplone

    uvx cookieplone project
cd project-title

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

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

  3. Add @eeacms/volto-columns-block to the addons key of your project's volto.config.js

  4. Install or refresh the project setup

    make install

  5. Start backend

    make backend-start

    ...wait for backend to set up and start with Ready to handle requests

  6. Start frontend

    make frontend-start

  7. Go to http://localhost:3000

  8. Happy hacking!

    cd packages/volto-columns-block/

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-columns-block to mrs.developer.json

Go to:

cd packages/volto-columns-block/

Start:

make
make start

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

Open Cypress Interface:

make cypress-open

Or run it:

make cypress-run