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 e72a4cf commit d5edf70
Showing 1 changed file with 12 additions and 18 deletions.
30 changes: 12 additions & 18 deletions DEVELOP.md
Expand Up @@ -16,30 +16,26 @@

1. Go to http://localhost:3000

1. Happy hacking!
1. Initialize git hooks

```Bash
cd src/addons/volto-slate-zotero/
yarn prepare
```

1. Happy hacking!

### Or add @eeacms/volto-slate-zotero 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/)

1. Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`

$ npm install -g yo
$ npm install -g @plone/generator-volto
$ npm install -g mrs-developer
npm install -g yo @plone/generator-volto mrs-developer

1. Create new volto app

$ yo @plone/volto my-volto-project \
--workspace src/addons/volto-slate-zotero \
--addon @eeacms/volto-slate-zotero \
--no-interactive \
--skip-install
$ cd my-volto-project
yo @plone/volto my-volto-project --addon @eeacms/volto-slate-zotero --skip-install
cd my-volto-project

1. Add the following to `mrs.developer.json`:

Expand All @@ -54,28 +50,26 @@ Before starting make sure your development environment is properly set. See [Vol

1. Install

$ yarn develop
$ yarn
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

$ yarn start
yarn start

1. Go to http://localhost:3000

1. Happy hacking!

$ cd src/addons/volto-slate-zotero/
cd src/addons/volto-slate-zotero/

## Cypress

Expand Down

0 comments on commit d5edf70

Please sign in to comment.