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 34a627e commit 3eeaf7a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 43 deletions.
13 changes: 6 additions & 7 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-banner/
yarn prepare
```

1. Happy hacking!

### Or add @eeacms/volto-banner 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 @@ -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 Down
57 changes: 21 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,23 +33,6 @@ It is configurable through `/controlpanel/banner`.

## Getting started

### Start Plone backend with Docker

1. Get the latest Docker images

```
docker pull plone
docker pull plone/volto
```

1. Start Plone backend

```
docker run -it --rm -p 8080:8080 -e SITE=Plone -e ADDONS="eea.banner" -e PROFILES="profile-eea.banner:default" plone
```

1. Go to http://localhost:3000

### Try volto-banner with Docker

git clone https://github.com/eea/volto-banner.git
Expand All @@ -61,42 +44,44 @@ Go to http://localhost:3000

### Add volto-banner 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
```

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-banner"
],
```JSON
"addons": [
"@eeacms/volto-banner"
],

"dependencies": {
"@eeacms/volto-banner": "^2.0.0"
}
```
"dependencies": {
"@eeacms/volto-banner": "*"
}
```

- If not, create one:
* If not, create one:

```
npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --addon @eeacms/volto-banner
cd my-volto-project
```
```
npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --canary --addon @eeacms/volto-banner
cd my-volto-project
```

1. Install new add-ons and start Volto:
1. Install new add-ons and restart Volto:

```
yarn
yarn start
```

2. Go to http://localhost:3000
3. Login `admin:admin`
4. Go to `Site Setup > Banner settings` and configure your banner
1. Go to http://localhost:3000

1. Happy editing!

## Release

Expand Down

0 comments on commit 3eeaf7a

Please sign in to comment.