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 fbc69ba commit 982fcbc
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 18 deletions.
17 changes: 7 additions & 10 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-slate-footnote/
yarn prepare
```

1. Happy hacking!

### Or add @eeacms/volto-slate-footnote 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,10 +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 \
--workspace src/addons/volto-slate-footnote \
--addon @eeacms/volto-slate-footnote \
--skip-install
yo @plone/volto my-volto-project --addon @eeacms/volto-slate-footnote --skip-install
cd my-volto-project

1. Add the following to `mrs.developer.json`:
Expand All @@ -51,17 +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 run -d --name plone -p 8080:8080 -e SITE=Plone 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
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,33 +44,32 @@ Go to http://localhost:3000

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-slate-footnote"
"@eeacms/volto-slate-footnote"
],
"dependencies": {
"@eeacms/volto-slate-footnote": "*"
"@eeacms/volto-slate-footnote": "*"
}
```

1. If not, create one:
* If not, create one:

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


1. Install new add-ons and restart Volto:

```
Expand Down

0 comments on commit 982fcbc

Please sign in to comment.