From efb0708c878cb0569172af49a94c224f85f408f8 Mon Sep 17 00:00:00 2001 From: Alin Voinea Date: Fri, 29 Sep 2023 09:37:12 +0300 Subject: [PATCH] docs: Update README and DEVELOP --- DEVELOP.md | 37 ++++++++++++++++++++----------------- README.md | 41 ++++++++++++++++++++++++++++++++++------- 2 files changed, 54 insertions(+), 24 deletions(-) diff --git a/DEVELOP.md b/DEVELOP.md index 783f1ec..00cda32 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-columns-block/ + yarn prepare ``` +1. Happy hacking! + ### Or add @eeacms/volto-columns-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/) @@ -32,7 +34,7 @@ Before starting make sure your development environment is properly set. See [Vol 1. Create new volto app - yo @plone/volto my-volto-project --addon @eeacms/volto-columns-block --workspace src/addons/volto-columns-block --skip-install + yo @plone/volto my-volto-project --addon @eeacms/volto-columns-block --skip-install cd my-volto-project 1. Add the following to `mrs.developer.json`: @@ -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 @@ -71,15 +70,6 @@ Before starting make sure your development environment is properly set. See [Vol 1. Happy hacking! cd src/addons/volto-columns-block/ -frontend - - $ yarn start - -1. Go to http://localhost:3000 - -1. Happy hacking! - - $ cd src/addons/volto-columns-block/ ## Cypress @@ -103,6 +93,19 @@ Start: This will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-columns-block` block installed. +Open Cypress Interface: + + ```Bash + make cypress-open + ``` + +Or run it: + + ```Bash + make cypress-run + ``` +his will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-columns-block` block installed. + Open Cypress Interface: ```Bash diff --git a/README.md b/README.md index f6e8132..48692d0 100644 --- a/README.md +++ b/README.md @@ -31,27 +31,54 @@ blocks container. ### Try volto-columns-block with Docker -1. Get the latest Docker images + git clone https://github.com/eea/volto-columns-block.git + cd volto-columns-block + make + make start +Go to http://localhost:3000 + +### Add volto-columns-block to your Volto project + +1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone + + ```Bash + docker compose up backend ``` - docker pull plone - docker pull plone/volto + +1. Start Volto frontend + +* If you already have a volto project, just update `package.json`: + + ```JSON + "addons": [ + "@eeacms/volto-columns-block" + ], + + "dependencies": { + "@eeacms/volto-columns-block": "*" + } ``` -1. Start Plone backend +* If not, create one: ``` - docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone + npm install -g yo @plone/generator-volto + yo @plone/volto my-volto-project --canary --addon @eeacms/volto-columns-block + cd my-volto-project ``` -1. Start Volto frontend +1. Install new add-ons and restart Volto: ``` - docker run -it --rm -p 3000:3000 --link plone -e ADDONS="@eeacms/volto-columns-block" plone/volto + yarn + yarn start ``` 1. Go to http://localhost:3000 +1. Happy editing! + ### Add volto-columns-block to your Volto project 1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone