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 9fb9754 commit b1146f2
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 12 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-metadata-block/
yarn prepare
```

1. Happy hacking!

### Or add @eeacms/volto-metadata-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 @@ -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
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,16 @@
[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-metadata-block-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-metadata-block-develop)


[Volto](https://github.com/plone/volto) add-on

## Features
[Volto](https://github.com/plone/volto#volto) add-on: Metadata Block that enables Document metadata insertion within the Blocks area.

Demo GIF
### Metadata block

![Demo](https://github.com/eea/volto-metadata-block/raw/docs/docs/volto-metadata-block.gif)

### Metadata section block

![Demo](https://github.com/eea/volto-metadata-block/raw/docs/docs/volto-metadata-section-block.gif)

## Getting started

Expand Down Expand Up @@ -75,11 +80,16 @@ Go to http://localhost:3000

## Release

See [RELEASE.md](https://github.com/eea/volto-metadata-block/blob/master/RELEASE.md).
See [RELEASE.md](https://github.com/eea/volto-metadata-block/blob/master/RELEASE.md)


## How to contribute

See [DEVELOP.md](https://github.com/eea/volto-metadata-block/blob/master/DEVELOP.md).
See [DEVELOP.md](https://github.com/eea/volto-metadata-block/blob/master/DEVELOP.md)

## See also

- [volto-slate-metadata-mentions](https://github.com/eea/volto-slate-metadata-mentions)

## Copyright and license

Expand Down

0 comments on commit b1146f2

Please sign in to comment.