docs: Update README DEVELOP

eea · Sep 29, 2023 · 14bcb5f · 14bcb5f
1 parent 7197b52
commit 14bcb5f
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 73 deletions.
diff --git a/DEVELOP.md b/DEVELOP.md
@@ -2,89 +2,74 @@
 
 ## Develop
 
-### With Docker
-
 1. Make sure you have `docker` and `docker compose` installed and running on your machine:
 
-    ```bash
+    ```Bash
     git clone https://github.com/eea/volto-accordion-block.git
     cd volto-accordion-block
     git checkout -b bugfix-123456 develop
     make
     make start
     ```
 
-1. Wait for `Volto started at 0.0.0.0:3000` message
+1. Wait for `Volto started at 0.0.0.0:3000` meesage
 
 1. Go to http://localhost:3000
 
-1.  Happy hacking!
+1. Initialize git hooks
 
-    ```bash
-    cd src/addons/volto-accordion-block/
+    ```Bash
+    yarn prepare
     ```
 
-### Or add volto-accordion-block to your Volto project
+1. Happy hacking!
+
+### Or add @eeacms/volto-accordion-block to your Volto project
 
-Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://6.docs.plone.org/volto/getting-started/install.html)
+Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
 
 1.  Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
 
-    ```bash
-    npm install -g yo @plone/generator-volto mrs-developer
-    ```
+        npm install -g yo @plone/generator-volto mrs-developer
 
 1.  Create new volto app
 
-    ```bash
-    yo @plone/volto my-volto-project --addon @eeacms/volto-accordion-block --skip-install
-    cd my-volto-project
-    ```
+        yo @plone/volto my-volto-project --addon @eeacms/volto-accordion-block --skip-install
+        cd my-volto-project
 
 1.  Add the following to `mrs.developer.json`:
 
-    ```JSON
-    {
-        "volto-accordion-block": {
-            "url": "https://github.com/eea/volto-accordion-block.git",
-            "package": "@eeacms/volto-accordion-block",
-            "branch": "develop",
-            "path": "src"
+        {
+            "volto-accordion-block": {
+                "url": "https://github.com/eea/volto-accordion-block.git",
+                "package": "@eeacms/volto-accordion-block",
+                "branch": "develop",
+                "path": "src"
+            }
         }
-    }
-    ```
 
 1.  Install
 
-    ```bash
-    yarn
-    ```
+        make develop
+        yarn
 
 1.  Start backend
 
-    ```bash
-    docker compose up backend
-    ```
+        docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend
 
-    ...wait for backend to set up and start - `Ready to handle requests`:
+    ...wait for backend to setup and start - `Ready to handle requests`:
 
     ...you can also check http://localhost:8080/Plone
 
 1.  Start frontend
 
-    ```bash
-    yarn start
-    ```
+        yarn start
 
 1.  Go to http://localhost:3000
 
 1.  Happy hacking!
 
-    ```bash
-    cd src/addons/volto-accordion-block/
-    ```
-
----
+        cd src/addons/volto-accordion-block/
 
 ## Cypress
 
@@ -95,13 +80,13 @@ project where you added `volto-accordion-block` to `mrs.developer.json`
 
 Go to:
 
-  ```bash
+  ```BASH
   cd src/addons/volto-accordion-block/
   ```
 
 Start:
 
-  ```bash
+  ```Bash
   make
   make start
   ```
@@ -110,16 +95,15 @@ This will build and start with Docker a clean `Plone backend` and `Volto Fronten
 
 Open Cypress Interface:
 
-  ```bash
+  ```Bash
   make cypress-open
   ```
 
 Or run it:
 
-  ```bash
+  ```Bash
   make cypress-run
   ```
----
 
 ## Prettier
 

diff --git a/README.md b/README.md
@@ -27,51 +27,49 @@
 
 ### Try volto-accordion-block with Docker
 
-    ```bash
-    git clone https://github.com/eea/volto-accordion-block.git
-    cd volto-accordion-block
-    make
-    make start
-    ```
+      git clone https://github.com/eea/volto-accordion-block.git
+      cd volto-accordion-block
+      make
+      make start
 
 Go to http://localhost:3000
 
 ### Add volto-accordion-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
-    ```
+   ```Bash
+   docker compose up backend
+   ```
 
 1. Start Volto frontend
 
-- If you already have a volto project, just update `package.json`:
+* If you already have a volto project, just update `package.json`:
 
-    ```json
-    "addons": [
-        "@eeacms/volto-accordion-block"
-    ],
+   ```JSON
+   "addons": [
+       "@eeacms/volto-accordion-block"
+   ],
 
-    "dependencies": {
-        "@eeacms/volto-accordion-block": "*"
-    }
-    ```
+   "dependencies": {
+       "@eeacms/volto-accordion-block": "*"
+   }
+   ```
 
-- If not, create one:
+* If not, create one:
 
-    ```bash
-    npm install -g yo @plone/generator-volto
-    yo @plone/volto my-volto-project --addon @eeacms/volto-accordion-block
-    cd my-volto-project
-    ```
+   ```
+   npm install -g yo @plone/generator-volto
+   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-accordion-block
+   cd my-volto-project
+   ```
 
 1. Install new add-ons and restart Volto:
 
-    ```bash
-    yarn
-    yarn start
-    ```
+   ```
+   yarn
+   yarn start
+   ```
 
 1. Go to http://localhost:3000