Skip to content

Commit

Permalink
docs: Update README and DEVELOP
Browse files Browse the repository at this point in the history
  • Loading branch information
avoinea committed Sep 29, 2023
1 parent 4c58155 commit efb0708
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 24 deletions.
37 changes: 20 additions & 17 deletions DEVELOP.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand All @@ -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`:
Expand All @@ -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
Expand All @@ -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

Expand All @@ -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
Expand Down
41 changes: 34 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit efb0708

Please sign in to comment.