volto-grid-block

December 1, 2020 ยท View on GitHub

Develop

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
    $ npm install -g @plone/generator-volto
    $ npm install -g mrs-developer
    
  2. Create new volto app

    $ yo @plone/volto my-volto-project --addon @eeacms/volto-grid-block --workspace src/addons/volto-grid-block
    $ cd my-volto-project
    
  3. Add the following to mrs.developer.json:

    {
        "volto-grid-block": {
            "url": "https://github.com/eea/volto-grid-block.git",
            "package": "@eeacms/volto-grid-block",
            "branch": "develop",
            "path": "src"
        }
    }
    
  4. Install

    $ yarn develop
    $ yarn
    
  5. Start backend

    $ docker run -d --name plone -p 8080:8080 -e SITE=Plone plone
    

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

    $ docker logs -f plone
    

    ...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-grid-block/