DEVELOP.md

volto-slate

The fast way to develop this addon

1. Assuming everything is right about your development environment, make a clone of this repo, then:

   make build-frontend

2. This will create a project folder with a bootstrapped Volto.

   cd project yarn start

Just change the code in your clone and it will automatically refresh Volto!

Develop

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

1. Make sure you have installed needed dev tools

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

2. Create new volto app

   yo @plone/volto \
        my-dev-project \
        --addon volto-slate:asDefault \
        --workspace src/addons/volto-slate \
        --skip-install
   
   cd my-dev-project
   

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

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

4. Install

   yarn develop
   yarn
   

5. Start backend

   docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" 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. Login with admin:admin

9. Create a new Page and add a new Text block.

10. Happy hacking!

    cd src/addons/volto-slate/