diff --git a/DEVELOP.md b/DEVELOP.md index aa6971c..491c3c2 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -16,12 +16,14 @@ 1. Go to http://localhost:3000 -1. Happy hacking! +1. Initialize git hooks ```Bash - cd src/addons/volto-timeline-block/ + yarn prepare ``` +1. Happy hacking! + ### Or add @eeacms/volto-timeline-block to your Volto project Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/) @@ -48,18 +50,15 @@ Before starting make sure your development environment is properly set. See [Vol 1. Install - yarn develop + make develop yarn 1. Start backend - docker pull plone - docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone + 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`: - docker logs -f plone - ...you can also check http://localhost:8080/Plone 1. Start frontend diff --git a/README.md b/README.md index 4a8141c..33b55d6 100644 --- a/README.md +++ b/README.md @@ -22,30 +22,16 @@ ![Timeline Block](https://github.com/eea/volto-timeline-block/raw/develop/docs/timeline-block.png) ![Timeline Block Demo](https://github.com/eea/volto-timeline-block/raw/docs/docs/volto-timeline.gif) - ## Getting started ### Try volto-timeline-block with Docker -1. Get the latest Docker images - - ``` - docker pull plone - docker pull plone/volto - ``` - -1. Start Plone backend - ``` - docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone - ``` - -1. Start Volto frontend + git clone https://github.com/eea/volto-timeline-block.git + cd volto-timeline-block + make + make start - ``` - docker run -it --rm -p 3000:3000 --link plone -e ADDONS="@eeacms/volto-timeline-block" plone/volto - ``` - -1. Go to http://localhost:3000 +Go to http://localhost:3000 ### Add volto-timeline-block to your Volto project @@ -65,7 +51,7 @@ ], "dependencies": { - "@eeacms/volto-timeline-block": "^1.0.0" + "@eeacms/volto-timeline-block": "*" } ``` @@ -73,7 +59,7 @@ ``` npm install -g yo @plone/generator-volto - yo @plone/volto my-volto-project --addon @eeacms/volto-timeline-block + yo @plone/volto my-volto-project --canary --addon @eeacms/volto-timeline-block cd my-volto-project ``` @@ -106,4 +92,3 @@ See [LICENSE.md](https://github.com/eea/volto-timeline-block/blob/master/LICENSE ## Funding [European Environment Agency (EU)](http://eea.europa.eu) -