Skip to content

Commit

Permalink
docs: Update README and add demo gifs
Browse files Browse the repository at this point in the history
  • Loading branch information
avoinea committed Sep 29, 2023
1 parent 9ec2d53 commit ad00749
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 22 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-eea-website-theme/
yarn prepare
```

1. Happy hacking!

### Or add @eeacms/volto-eea-website-theme 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
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,25 +41,25 @@ Go to http://localhost:3000

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

"dependencies": {
"@eeacms/volto-eea-website-theme": "^1.0.0"
}
```
"dependencies": {
"@eeacms/volto-eea-website-theme": "*"
}
```

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

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

1. Install new add-ons and restart Volto:

Expand Down

0 comments on commit ad00749

Please sign in to comment.