DEVELOP.md

volto-countdown-block

Develop

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

   git clone https://github.com/rnunez80/volto-countdown-block.git
   cd volto-countdown-block
   git checkout -b develop
   make
   make start

2. Wait for Volto started at 0.0.0.0:3000 meesage

3. Go to http://localhost:3000

4. Happy hacking!

   cd src/addons/volto-countdown-block/

Or add volto-countdown-block to your Volto project

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 volto-countdown-block
   $ cd my-volto-project
   

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

   {
       "volto-countdown-block": {
           "url": "https://github.com/rnunez80/volto-countdown-block.git",
           "package": "volto-countdown-block",
           "branch": "develop",
           "path": "src"
       }
   }
   

4. Install

   $ yarn
   

5. Start backend

   $ docker pull plone/plone-backend
   $ docker run -d --name plone-backend -p 8080:8080 -e SITE="Plone" -e PROFILES="plone.restapi:blocks" plone/plone-backend:6.0
   

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

   $ docker logs -f plone-backend
   

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